Type Alias ICacheAdapter<TType>

Type declaration

• add:function

  • add(key, value, ttl): PromiseLike<boolean>

  • The add method add a new key. Returns true if the key where added otherwise false will be returned. You must provide a ttl value. If null is passed, the item will not expire.

    Parameters

    • key: string
    • value: TType
    • ttl: null | TimeSpan

    Returns PromiseLike<boolean>

• clear:function

  • clear(): PromiseLike<void>

  • The clear method removes all keys that starts prefix.

    Returns PromiseLike<void>

• exists:function

  • exists(key): PromiseLike<boolean>

  • The exists returns true if the key if exists otherwise false will be returned.

    Parameters

    • key: string

    Returns PromiseLike<boolean>

• get:function

  • get(key): PromiseLike<null | TType>

  • The get returns the key value if found otherwise null will be returned.

    Parameters

    • key: string

    Returns PromiseLike<null | TType>

• getGroup:function

  • getGroup(): string

  • The getGroup method returns the group name.

    Returns string

• increment:function

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

  • The increment method will increment the given key if found otherwise nonthing will occur. Returns true if key is incremented otherwise false will be returned. 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, value, ttl): PromiseLike<boolean>

  • The put method replaces a key if the key exists including the ttl value or adds key that do not exists with a given ttl. Returns true if the key where replaced otherwise false is returned. You must provide a ttl value. If null is passed, the item will not expire.

    Parameters

    • key: string
    • value: TType
    • ttl: null | TimeSpan

    Returns PromiseLike<boolean>

• remove:function

  • remove(key): PromiseLike<boolean>

  • The remove method removes a key. Returns true if the key is removed otherwise false is returned.

    Parameters

    • key: string

    Returns PromiseLike<boolean>

• update:function

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

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

    Parameters

    • key: string
    • value: TType

    Returns PromiseLike<boolean>

• withGroup:function

  • withGroup(group): ICacheAdapter<TType>

  • The withGroup method returns a new ICacheAdapter instance that groups keys together. Only keys in the group can be updated, removed, or retrieved, leaving keys outside the group unaffected.

    Parameters

    • group: OneOrMore<string>

    Returns ICacheAdapter<TType>