Type Alias IDatabaseCacheAdapter<TType>

Type declaration

• find:function

  • find(key: string): PromiseLike<null | ICacheData<TType>>

  • The find method returns the the key data which includs ICacheData.value and ICacheData.expiration.

    Parameters

    • key: string

    Returns PromiseLike<null | ICacheData<TType>>

• incrementUnexpired:function

  • incrementUnexpired(data: ICacheUpdate<number>): PromiseLike<number>

  • The incrementUnexpired should always throw an error if the existing item is not a number type.

    Parameters

    • data: ICacheUpdate<number>

    Returns PromiseLike<number>

• insert:function

  • insert(data: ICacheInsert<TType>): PromiseLike<void>

  • The insert method inserts the given cache data.

    Parameters

    • data: ICacheInsert<TType>

    Returns PromiseLike<void>

• removeAll:function

  • removeAll(): PromiseLike<void>

  • The removeAll method removes all keys from the cache.

    Returns PromiseLike<void>

• removeByKeyPrefix:function

  • removeByKeyPrefix(prefix: string): PromiseLike<void>

  • The removeByKeyPrefix method removes all the keys in the cache that starts with the given prefix.

    Parameters

    • prefix: string

    Returns PromiseLike<void>

• removeExpiredMany:function

  • removeExpiredMany(keys: string[]): PromiseLike<number>

  • The removeExpiredMany method removes multiple expired keys.

    Parameters

    • keys: string[]

    Returns PromiseLike<number>

• removeUnexpiredMany:function

  • removeUnexpiredMany(keys: string[]): PromiseLike<number>

  • The removeExpiredMany method removes multiple unexpired keys.

    Parameters

    • keys: string[]

    Returns PromiseLike<number>

• updateExpired:function

  • updateExpired(data: ICacheInsert<TType>): PromiseLike<number>

  • The removeExpiredMany method updates a expired key.

    Parameters

    • data: ICacheInsert<TType>

    Returns PromiseLike<number>

• updateUnexpired:function

  • updateUnexpired(data: ICacheUpdate<TType>): PromiseLike<number>

  • The removeExpiredMany method updates a unexpired key.

    Parameters

    • data: ICacheUpdate<TType>

    Returns PromiseLike<number>

• upsert:function

  • upsert(data: ICacheInsert<TType>): PromiseLike<null | ICacheDataExpiration>

  • The upsert method inserts a key and if the key already exists then key will be updated with new data.value and data.expiration. The method always returns the old cache data if it exists otherwise null will be returned.

    Parameters

    • data: ICacheInsert<TType>

    Returns PromiseLike<null | ICacheDataExpiration>