Type Alias ICache<TType>

ICache: IReadableCache<TType> & {
    add(key: string, value: TType, ttl?: ITimeSpan): Promise<boolean>;
    addOrFail(key: string, value: TType, ttl?: ITimeSpan): Promise<void>;
    clear(): Promise<void>;
    decrement(key: string, value?: Extract<TType, number>): Promise<boolean>;
    decrementOrFail(key: string, value?: Extract<TType, number>): Promise<void>;
    getAndRemove(key: string): Promise<null | TType>;
    getOrAdd(
        key: string,
        valueToAdd: TType,
        ttl?: null | ITimeSpan,
    ): Promise<TType>;
    increment(key: string, value?: Extract<TType, number>): Promise<boolean>;
    incrementOrFail(key: string, value?: Extract<TType, number>): Promise<void>;
    put(key: string, value: TType, ttl?: ITimeSpan): Promise<boolean>;
    remove(key: string): Promise<boolean>;
    removeMany(keys: string[]): Promise<boolean>;
    removeOrFail(key: string): Promise<void>;
    update(key: string, value: TType): Promise<boolean>;
    updateOrFail(key: string, value: TType): Promise<void>;
}

The ICache contract defines a way for storing and reading as key-value pairs independent of data storage.

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

Type Parameters

  • TType = unknown

Type declaration

  • add:function
  • addOrFail:function
  • clear:function
    • clear(): Promise<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 Promise<void>

  • decrement:function
    • decrement(key: string, value?: Extract<TType, number>): Promise<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 Promise<boolean>

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

      Throws

      Throws

  • decrementOrFail:function
    • decrementOrFail(key: string, value?: Extract<TType, number>): Promise<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 Promise<void>

      Throws

      Throws

      Throws

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

      Throws

  • getOrAdd:function
    • getOrAdd(key: string, valueToAdd: TType, ttl?: null | ITimeSpan): Promise<TType>

    • The getOrAdd method retrieves the value for the given key if it exists, otherwise adds the valueToAdd to the cache and returns it.

      Parameters

      • key: string

        The cache key to retrieve or add.

      • valueToAdd: TType

        The value to store if the key is not found.

      • Optionalttl: null | ITimeSpan

        Optional time-to-live for the cached item. If null is passed, the item will not expire.

      Returns Promise<TType>

      The cached value if the key exists, or the newly added value.

      Throws

  • increment:function
    • increment(key: string, value?: Extract<TType, number>): Promise<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 Promise<boolean>

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

      Throws

      Throws

  • incrementOrFail:function
    • incrementOrFail(key: string, value?: Extract<TType, number>): Promise<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 Promise<void>

      Throws

      Throws

      Throws

  • put:function
  • remove:function
    • remove(key: string): Promise<boolean>

    • The remove method removes the given key.

      Parameters

      • key: string

      Returns Promise<boolean>

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

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

    • The removeMany method removes many keys.

      Parameters

      • keys: string[]

      Returns Promise<boolean>

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

  • removeOrFail:function
    • removeOrFail(key: string): Promise<void>

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

      Parameters

      • key: string

      Returns Promise<void>

      Throws

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

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

      Parameters

      Returns Promise<boolean>

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

      Throws

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

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

      Parameters

      Returns Promise<void>

      Throws

      Throws

Settings

Member Visibility