Type Alias IDatabaseCacheAdapter<TType>

Type declaration

• find:function

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

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

    Parameters

    • key: string

    Returns Promise<null | ICacheData<TType>>

• incrementUnexpired:function

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

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

    Parameters

    • data: ICacheUpdate<number>

    Returns Promise<number>

• insert:function

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

  • The insert method inserts the given cache data.

    Parameters

    • data: ICacheInsert<TType>

    Returns Promise<void>

• removeAll:function

  • removeAll(): Promise<void>

  • The removeAll method removes all keys from the cache.

    Returns Promise<void>

• removeByKeyPrefix:function

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

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

    Parameters

    • prefix: string

    Returns Promise<void>

• removeExpiredMany:function

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

  • The removeExpiredMany method removes multiple expired keys.

    Parameters

    • keys: string[]

    Returns Promise<number>

• removeUnexpiredMany:function

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

  • The removeExpiredMany method removes multiple unexpired keys.

    Parameters

    • keys: string[]

    Returns Promise<number>

• updateExpired:function

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

  • The removeExpiredMany method updates a expired key.

    Parameters

    • data: ICacheInsert<TType>

    Returns Promise<number>

• updateUnexpired:function

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

  • The removeExpiredMany method updates a unexpired key.

    Parameters

    • data: ICacheUpdate<TType>

    Returns Promise<number>

• upsert:function

  • upsert(data: ICacheInsert<TType>): Promise<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 Promise<null | ICacheDataExpiration>