Function cacheIt

  • cacheIt<T extends GeneralFunction>(
        obj: T,
        options?: CacheItOptions,
    ): CachedFunction<T>

  • make all methods of object are cached

    Type Parameters

    Parameters

    Returns CachedFunction<T>

    Since

    5.16.0

    Example


       // set max cache size
       const f = cacheIt((value: number) => (++idx) + value, {
         providerOptions: {
           params: {
             max_entries: 2
           }
         }
       });
       expect(f.__cache_storage["_maxSize"]).toBe(2);

       expect(f(0)).toBe(1);
       expect(f(0)).toBe(1);
  • cacheIt<T extends Class>(obj: T, options?: CacheItOptions): CachedClass<T>

  • create a class wrapper, the instance created by that wrapper will automatically apply cacheIt

    Type Parameters

    Parameters

    Returns CachedClass<T>

    Since

    5.16.0

    Example

     class A {
         constructor(idx = 0) { this.idx = idx; }
         private idx: number
         public add(value: number) {
           return (++this.idx) + value;
         }
       }
       const CachedA = cacheIt(A);
       const a = new CachedA(1);
       expect(a.add(0)).toBe(2);
       expect(a.add(0)).toBe(2);

       expect(a.add(1)).toBe(4);
       expect(a.add(1)).toBe(4);
  • cacheIt<T extends object>(obj: T, options?: CacheItOptions): CachedObject<T>

  • make function is cached, default with LRU container

    Type Parameters

    • T extends object

    Parameters

    Returns CachedObject<T>

    Since

    5.16.0

  • cacheIt<T extends object>(obj: T, options?: CacheItOptions): CachedObject<T>

  • make all methods of object are cached

    Type Parameters

    • T extends object

    Parameters

    Returns CachedObject<T>

    Since

    5.16.0

    Example


       // set max cache size
       const f = cacheIt((value: number) => (++idx) + value, {
         providerOptions: {
           params: {
             max_entries: 2
           }
         }
       });
       expect(f.__cache_storage["_maxSize"]).toBe(2);

       expect(f(0)).toBe(1);
       expect(f(0)).toBe(1);

Settings

Member Visibility