Function ttl

Wrap a function with time-to-live (TTL) caching.

  • ttl<T extends (...args: A) => any, A extends any[], K = string>(
        run: T,
        options?: { key?: (args: A) => K; timeout?: number },
    ): T & IClearable<K> & IControl<K, ReturnType<T>>

    Type Parameters

    • T extends (...args: A) => any

      The function type.

    • A extends any[]

      The argument types of the function.

    • K = string

      The key type for caching.

    Parameters

    • run: T

      The function to wrap.

    • Optionaloptions: { key?: (args: A) => K; timeout?: number }

      The configuration options.

      • Optionalkey?: (args: A) => K

        The key generator function that generates a key based on function arguments.

      • Optionaltimeout?: number

        The TTL duration in milliseconds.

    Returns T & IClearable<K> & IControl<K, ReturnType<T>>

    • The wrapped function with caching capability.

Settings

Member Visibility