TypeScript definitions about nano-memoize HOT 5 CLOSED

Ah ok,

If you wish you can delete comments of course, I took them from your README.

• Just create a definition file for each published file:
  • index.d.ts
  • browser/nano-memoize.d.ts
  • dist/nano-memoize.d.ts
• Copy definitions below into them. Don't forget to add those files to package.json, since they should be included in published npm module.

export default function memoized<T extends Function>(
  func: T,
  options?: {
    /**
     * Only use the provided maxArgs for cache look-up, useful for ignoring final callback arguments
     */
    maxArgs?: number;
    /**
     * Number of milliseconds to cache a result, set to `Infinity` to never create timers or expire
     */
    maxAge?: number;
    /**
     * The serializer/key generator to use for single argument functions (optional, not recommended)
     * must be able to serialize objects and functions, by default a WeakMap is used internally without serializing
     */
    serializer?: (...args: any[]) => any;
    /**
     * the equals function to use for multi-argument functions (optional, try to avoid) e.g. deepEquals for objects
     */
    equals?: (...args: any[]) => boolean;
    /**
     * Forces the use of multi-argument paradigm, auto set if function has a spread argument or uses `arguments` in its body.
     */
    vargs?: boolean;
  }
): T;

Brief Description

Above type definition tells TS compiler, that you are default exporting a function with given parameters.

? indicates optional and not mandatory parameters.

For example equals?: (...args: any[]) => boolean; means, equals optionally expect a function with any inputs which returns a boolean.

<T extends Function>(func: T): T means T is a function. Its signature comes from func parameter and memoized function returns a function which has same signature as func

Hope this helps.

from nano-memoize.

@ozum Thanks for the comment. I am not really sure what to do with it. I have very limited experience with TypeScript.

from nano-memoize.

Added clear method to typescript declaration, since nano memoize can clear it's cache.

const memo = nanomemoize(someFn)
memo.clear()

declare module 'nano-memoize' {
  interface nanomemoize {
    clear(): void
  }
  export default function memoized<T extends Function>(
    func: T,
    options?: {
      /**
       * Only use the provided maxArgs for cache look-up, useful for ignoring final callback arguments
       */
      maxArgs?: number
      /**
       * Number of milliseconds to cache a result, set to `Infinity` to never create timers or expire
       */
      maxAge?: number
      /**
       * The serializer/key generator to use for single argument functions (optional, not recommended)
       * must be able to serialize objects and functions, by default a WeakMap is used internally without serializing
       */
      serializer?: (...args: any[]) => any
      /**
       * the equals function to use for multi-argument functions (optional, try to avoid) e.g. deepEquals for objects
       */
      equals?: (...args: any[]) => boolean
      /**
       * Forces the use of multi-argument paradigm, auto set if function has a spread argument or uses `arguments` in its body.
       */
      vargs?: boolean
    }
  ): T & nanomemoize
}

from nano-memoize.

Why this still not merged !??

I would move to fast-memoize just because of the missing typing! As the performance difference is not always mattering! And i don't want to add types manually

(just a feedback! How it can feel)

Otherwise impressive work! Thanks

from nano-memoize.

from nano-memoize.