Type Alias ICache<TType>

Type declaration

• add:function

  • add(key, value, ttl?): LazyPromise<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

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

    Returns LazyPromise<boolean>

• addMany:function

  • addMany<TKeys>(values): LazyPromise<Record<TKeys, boolean>>

  • The addMany method adds new keys. Returns true for the keys that where added otherwise false will be returned.

    Type Parameters

    • TKeys extends string

    Parameters

    • values: Record<TKeys, WithTtlValue<TType>>

    Returns LazyPromise<Record<TKeys, boolean>>

• clear:function

  • clear(): LazyPromise<void>

  • The clear method removes all the keys in the cache.

    Returns LazyPromise<void>

• decrement:function

  • decrement(key, value?): LazyPromise<boolean>

  • The decrement method will decrement the given key if found otherwise nonthing will occur. Returns true if key exists otherwise false will be returned. An error will thrown if the key is not a number.

    Parameters

    • key: string
    • Optionalvalue: Extract<TType, number>

    Returns LazyPromise<boolean>

    Throws

    TypeCacheError An error will thrown if the key is not a number.

• exists:function

  • exists(key): LazyPromise<boolean>

  • The exists method returns true when key is found otherwise false will be returned.

    Parameters

    • key: string

    Returns LazyPromise<boolean>

• existsMany:function

  • existsMany<TKeys>(keys): LazyPromise<Record<TKeys, boolean>>

  • The existsMany method returns true for the keys that are found otherwise false will be returned.

    Type Parameters

    • TKeys extends string

    Parameters

    • keys: TKeys[]

    Returns LazyPromise<Record<TKeys, boolean>>

• get:function

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

  • The get method returns the value when key is found otherwise null will be returned.

    Parameters

    • key: string

    Returns LazyPromise<null | TType>

• getAndRemove:function

  • getAndRemove(key): LazyPromise<null | TType>

  • The getAndRemove method removes the given key and returns it when found otherwise null will be returned.

    Parameters

    • key: string

    Returns LazyPromise<null | TType>

• getGroup:function

  • getGroup(): string

  • The getGroup method returns the group name.

    Returns string

    Example

    import type { ICache } from "@daiso-tech/core";
    
    async function main(cache: ICache) {
      // Will be "@global"
      console.log(cache.getGroup())
    
      const cacheA = cache.withGroup("a");
    
      // Will be "@global/a"
      console.log(cacheA.getGroup())
    }
    Copy

• getMany:function

  • getMany<TKeys>(keys): LazyPromise<Record<TKeys, null | TType>>

  • The getMany returns the value for the keys that are found otherwise null will be returned.

    Type Parameters

    • TKeys extends string

    Parameters

    • keys: TKeys[]

    Returns LazyPromise<Record<TKeys, null | TType>>

• getOr:function

  • getOr(key, defaultValue): LazyPromise<TType>

  • The getOr method returns the value when key is found otherwise defaultValue will be returned.

    Parameters

    • key: string
    • defaultValue: AsyncLazyable<TType>

    Returns LazyPromise<TType>

• getOrAdd:function

  • getOrAdd(key, valueToAdd, ttl?): LazyPromise<TType>

  • The getOrAdd method will retrieve the given key if found otherwise valueToAdd will be added and returned.

    Parameters

    • key: string
    • valueToAdd: AsyncLazyable<GetOrAddValue<TType>>
    • Optionalttl: null | TimeSpan

    Returns LazyPromise<TType>

• getOrFail:function

  • getOrFail(key): LazyPromise<TType>

  • The getOrFail method returns the value when key is found otherwise an error will be thrown.

    Parameters

    • key: string

    Returns LazyPromise<TType>

    Throws

    KeyNotFoundCacheError

• getOrMany:function

  • getOrMany<TKeys>(keysWithDefaults): LazyPromise<Record<TKeys, TType>>

  • The getOrMany method returns the value for the keys that are found otherwise defaultValue will be returned.

    Type Parameters

    • TKeys extends string

    Parameters

    • keysWithDefaults: Record<TKeys, AsyncLazyable<TType>>

    Returns LazyPromise<Record<TKeys, TType>>

• increment:function

  • increment(key, value?): LazyPromise<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
    • Optionalvalue: Extract<TType, number>

    Returns LazyPromise<boolean>

    Throws

    TypeCacheError

• missing:function

  • missing(key): LazyPromise<boolean>

  • The missing method returns true when key is not found otherwise false will be returned.

    Parameters

    • key: string

    Returns LazyPromise<boolean>

• missingMany:function

  • missingMany<TKeys>(keys): LazyPromise<Record<TKeys, boolean>>

  • The missingMany method returns true for the keys that are not found otherwise false will be returned.

    Type Parameters

    • TKeys extends string

    Parameters

    • keys: TKeys[]

    Returns LazyPromise<Record<TKeys, boolean>>

• put:function

  • put(key, value, ttl?): LazyPromise<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
    • Optionalttl: null | TimeSpan

    Returns LazyPromise<boolean>

• putMany:function

  • putMany<TKeys>(values): LazyPromise<Record<TKeys, boolean>>

  • The putMany method replaces the keys that exists including their ttl values or adds keys that do not exists. Returns true for all the keys that where replaced otherwise false is returned.

    Type Parameters

    • TKeys extends string

    Parameters

    • values: Record<TKeys, WithTtlValue<TType>>

    Returns LazyPromise<Record<TKeys, boolean>>

• remove:function

  • remove(key): LazyPromise<boolean>

  • The remove method removes the given key when found. Returns true if the key is found otherwise false is returned.

    Parameters

    • key: string

    Returns LazyPromise<boolean>

• removeMany:function

  • removeMany<TKeys>(keys): LazyPromise<Record<TKeys, boolean>>

  • The removeMany method removes keys. Returns true for the keys that are removed otherwise false is returned.

    Type Parameters

    • TKeys extends string

    Parameters

    • keys: TKeys[]

    Returns LazyPromise<Record<TKeys, boolean>>

• update:function

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

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

    Parameters

    • key: string
    • value: TType

    Returns LazyPromise<boolean>

• updateMany:function

  • updateMany<TKeys>(values): LazyPromise<Record<TKeys, boolean>>

  • The updateMany method updates the given keys. Returns true for the keys that where updated otherwise false will be returned.

    Type Parameters

    • TKeys extends string

    Parameters

    • values: Record<TKeys, TType>

    Returns LazyPromise<Record<TKeys, boolean>>