Type Alias ICacheAdapter<TType>

ICacheAdapter: {
    add(
        key: string,
        value: TType,
        ttl: null | TimeSpan,
    ): PromiseLike<boolean>;
    get(key: string): PromiseLike<null | TType>;
    getAndRemove(key: string): PromiseLike<null | TType>;
    increment(key: string, value: number): PromiseLike<boolean>;
    put(key: string, value: TType, ttl: null | TimeSpan): PromiseLike<boolean>;
    removeAll(): PromiseLike<void>;
    removeByKeyPrefix(prefix: string): PromiseLike<void>;
    removeMany(keys: string[]): PromiseLike<boolean>;
    update(key: string, value: TType): PromiseLike<boolean>;
}

The ICacheAdapter contract defines a way for key-value pairs independent of data storage.

IMPORT_PATH: "@daiso-tech/core/cache/contracts"

Type Parameters

  • TType = unknown

Type declaration

  • add:function
    • add(key: string, value: TType, ttl: null | TimeSpan): PromiseLike<boolean>

    • The add method adds a key with given value when key doesn't exists. Returns true when key doesn't exists otherwise false will be returned. You can provide a ttl value. If null is passed, the item will not expire.

      Parameters

      Returns PromiseLike<boolean>

  • get:function
  • getAndRemove:function
    • getAndRemove(key: string): PromiseLike<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 PromiseLike<null | TType>

  • increment:function
    • increment(key: string, value: number): PromiseLike<boolean>

    • The increment method increments the given key with given value. Returns true if the key where incremented otherwise false will be returned. If values is not defined then it will increment the key with 1. An error will thrown if the key is not a number.

      Parameters

      • key: string
      • value: number

      Returns PromiseLike<boolean>

      Throws

      TypeCacheError

  • put:function
    • put(key: string, value: TType, ttl: null | TimeSpan): PromiseLike<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 and ttl. Returns true if the key where replaced otherwise false is returned.

      Parameters

      Returns PromiseLike<boolean>

  • removeAll:function
  • 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>

  • removeMany:function
    • removeMany(keys: string[]): PromiseLike<boolean>

    • The removeMany method removes many keys. Returns true if one of the keys where deleted otherwise false is returned.

      Parameters

      • keys: string[]

      Returns PromiseLike<boolean>

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

    • The update method updates the given key with given value. Returns true if the key where updated otherwise false will be returned.

      Parameters

      Returns PromiseLike<boolean>

Settings

Member Visibility