node-cache-redis
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

Const del

  • del(_keys?: string[]): Promise<number>

  • Delete keys

    Parameters

    • _keys: string[] = ...

    Returns Promise<number>

    The number of keys that were removed.

Const deleteAll

  • deleteAll(pattern?: string): Promise<number>

  • Deletes all keys matching pattern

    Parameters

    • pattern: string = '*'

      glob-style patterns/default '*'

    Returns Promise<number>

    The number of keys that were removed.

Const get

  • get(key: string): Promise<any>

  • Returns value or null when the key is missing

    Parameters

    • key: string

      key for the value stored

    Returns Promise<any>

    value or null when the key is missing

Const getDefaultTtlInS

  • getDefaultTtlInS(): undefined | number

  • Return the defaultTtlInS

    Returns undefined | number

Const getName

  • getName(): string

Const getPoolOptions

  • getPoolOptions(): Options

Const getRedisOptions

  • getRedisOptions(): ClientOpts

  • Returns redisOptions of this pool

    Returns ClientOpts

Const getStatus

  • getStatus(): RedisPoolStatus

  • Returns pool status and stats

    Returns RedisPoolStatus

Const getStore

  • getStore(): RedisStore

Const getset

  • getset(key: string, value: any, ttlInSeconds?: number): Promise<any>

  • Returns 'OK' if successful

    Parameters

    • key: string

      key for the value stored

    • value: any

      value to stored

    • Optional ttlInSeconds: number

      time to live in seconds

    Returns Promise<any>

    'OK' if successful

Const init

  • init(options: { defaultTtlInS?: number; logger?: Logger; name?: string; poolOptions?: Options; redisOptions: ClientOpts }): void

  • Parameters

    • options: { defaultTtlInS?: number; logger?: Logger; name?: string; poolOptions?: Options; redisOptions: ClientOpts }
      • Optional defaultTtlInS?: number

        Number of seconds to store by default

      • Optional logger?: Logger

        Inject your custom logger

      • Optional name?: string

        Name your cache store

      • Optional poolOptions?: Options

        opts from node-pool#createpool

      • redisOptions: ClientOpts

        opts from node_redis#options-object-properties

    Returns void

Const keys

  • keys(pattern?: string): Promise<string[]>

  • Returns all keys matching pattern

    Parameters

    • pattern: string = '*'

      glob-style patterns/default '*'

    Returns Promise<string[]>

    all keys matching pattern

Const set

  • set(key: string, value: any, ttlInSeconds?: number): Promise<string>

  • Returns 'OK' if successful

    Parameters

    • key: string

      key for the value stored

    • value: any

      value to stored

    • Optional ttlInSeconds: number

      time to live in seconds

    Returns Promise<string>

    'OK' if successful

Const setDefaultTtlInS

  • setDefaultTtlInS(ttl: number): undefined | number

  • Sets the defaultTtlInS

    Parameters

    • ttl: number

      new default ttl in seconds

    Returns undefined | number

Const unsetDefaultTtlInS

  • unsetDefaultTtlInS(): boolean

Const wrap

  • wrap(key: string, fn: Function, opts?: { ttlInSeconds?: number }): Promise<any>

  • Wraps promise to set its value if not exists.

    async

    Parameters

    • key: string

      key for the value stored

    • fn: Function

      function to call if not cache found

    • opts: { ttlInSeconds?: number } = ...

      options for wrap

      • Optional ttlInSeconds?: number

        time to live in seconds

    Returns Promise<any>

    'OK' if successful

Legend

Generated using TypeDoc