Type Alias IReadableCache<TType>

Type declaration

• exists:function

  • exists(key: string): ITask<boolean>

  • The exists method returns true when key is found otherwise false will be returned.

    Parameters

    • key: string

    Returns ITask<boolean>

• get:function

  • get(key: string): ITask<null | TType>

  • The get method returns the value when key is found otherwise null will be returned.

    Parameters

    • key: string

    Returns ITask<null | TType>

• getOr:function

  • getOr(key: string, defaultValue: AsyncLazyable<NoneFunc<TType>>): ITask<TType>

  • The getOr method will retrieve the given key if found otherwise defaultValue will be returned.

    Parameters

    • key: string
    • defaultValue: AsyncLazyable<NoneFunc<TType>>

      can be regular value, sync or async Invokable value and ITask value.

    Returns ITask<TType>

• getOrFail:function

  • getOrFail(key: string): ITask<TType>

  • The getOrFail method returns the value when key is found otherwise an error will be thrown.

    Parameters

    • key: string

    Returns ITask<TType>

    Throws

    KeyNotFoundCacheError

• missing:function

  • missing(key: string): ITask<boolean>

  • The missing method returns true when key is not found otherwise false will be returned.

    Parameters

    • key: string

    Returns ITask<boolean>