Type Alias ICacheBase<TType>

Type declaration

• add:function

  • add(key: string, value: TType, settings?: CacheWriteSettings): ITask<boolean>

  • The add method adds a key with given value when key doesn't exists.

    Parameters

    • key: string
    • value: TType
    • Optionalsettings: CacheWriteSettings

    Returns ITask<boolean>

    Returns true when key doesn't exists otherwise false will be returned.

• addOrFail:function

  • addOrFail(key: string, value: TType, settings?: CacheWriteSettings): ITask<void>

  • The addOrFail method adds a key with given value when key doesn't exists. Throws an error if the key exists.

    Parameters

    • key: string
    • value: TType
    • Optionalsettings: CacheWriteSettings

    Returns ITask<void>

    Throws

    KeyExistsCacheError

• clear:function

  • clear(): ITask<void>

  • The clear method removes all the keys in the cache. If a cache is in a group then only the keys part of the group will be removed.

    Returns ITask<void>

• decrement:function

  • decrement(key: string, value?: Extract<TType, number>): ITask<boolean>

  • The decrement method decrements the given key with given value. An error will thrown if the value is not a number.

    Parameters

    • key: string
    • Optionalvalue: Extract<TType, number>

      If not defined then it will be defaulted to 1.

    Returns ITask<boolean>

    Returns true if the key where decremented otherwise false will be returned.

    Throws

    TypeError

• decrementOrFail:function

  • decrementOrFail(key: string, value?: Extract<TType, number>): ITask<void>

  • The decrementOrFail method decrements the given key with given value. An error will thrown if the value is not a number or if the key is not found.

    Parameters

    • key: string
    • Optionalvalue: Extract<TType, number>

      If not defined then it will be defaulted to 1.

    Returns ITask<void>

    Throws

    KeyNotFoundCacheError

    Throws

    TypeError

• 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>

• getAndRemove:function

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

  • The getAndRemove method returns the value when key is found otherwise null will be returned. The key will be removed after it is 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>

• getOrAdd:function

  • getOrAdd(
        key: string,
        valueToAdd: AsyncLazyable<NoneFunc<TType>>,
        settings?: CacheWriteSettings,
    ): ITask<TType>

  • The getOrAdd method will retrieve the given key if found otherwise valueToAdd will be added and returned.

    Parameters

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

      can be regular value, sync or async Invokable value and ITask value.
    • Optionalsettings: CacheWriteSettings

    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

• increment:function

  • increment(key: string, value?: Extract<TType, number>): ITask<boolean>

  • The increment method increments the given key with given value. An error will thrown if the value is not a number.

    Parameters

    • key: string
    • Optionalvalue: Extract<TType, number>

      If not defined then it will be defaulted to 1.

    Returns ITask<boolean>

    Returns true if the key where incremented otherwise false will be returned.

    Throws

    TypeError

• incrementOrFail:function

  • incrementOrFail(key: string, value?: Extract<TType, number>): ITask<void>

  • The incrementOrFail method increments the given key with given value. An error will thrown if the value is not a number or if the key is not found.

    Parameters

    • key: string
    • Optionalvalue: Extract<TType, number>

      If not defined then it will be defaulted to 1.

    Returns ITask<void>

    Throws

    KeyNotFoundCacheError

    Throws

    TypeError

• 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>

• put:function

  • put(key: string, value: TType, settings?: CacheWriteSettings): ITask<boolean>

  • The put method replaces th given key with the given value and ttl if the key exists othwerwise it will add the given value with the given ttl.

    Parameters

    • key: string
    • value: TType
    • Optionalsettings: CacheWriteSettings

    Returns ITask<boolean>

    Returns true if the key where replaced otherwise false is returned.

• remove:function

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

  • The remove method removes the given key.

    Parameters

    • key: string

    Returns ITask<boolean>

    Returns true if the key is found otherwise false is returned.

• removeMany:function

  • removeMany(keys: Iterable<string, any, any>): ITask<boolean>

  • The removeMany method removes many keys.

    Parameters

    • keys: Iterable<string, any, any>

      The param items can be a string or an Iterable of strings. If the param items are an Iterable, it will be joined into a single string. Think of an Iterable as representing a path.

    Returns ITask<boolean>

    Returns true if one of the keys where deleted otherwise false is returned.

• removeOrFail:function

  • removeOrFail(key: string): ITask<void>

  • The removeOrFail method removes the given key. Throws an error if the key is not found.

    Parameters

    • key: string

    Returns ITask<void>

    Throws

    KeyNotFoundCacheError

• update:function

  • update(key: string, value: TType): ITask<boolean>

  • The update method updates the given key with given value.

    Parameters

    • key: string
    • value: TType

    Returns ITask<boolean>

    Returns true if the key where updated otherwise false will be returned.

• updateOrFail:function

  • updateOrFail(key: string, value: TType): ITask<void>

  • The updateOrFail method updates the given key with given value. Thorws error if the key is not found.

    Parameters

    • key: string
    • value: TType

    Returns ITask<void>

    Throws

    KeyNotFoundCacheError