Class KVManager

constructor

• new KVManager(options?: KVManagerOptions): KVManager

  Parameters

  • options: KVManagerOptions = {}

  Returns KVManager

id

name

client

• get client(): Redis | undefined

  The underlying ioredis client with the "redis" driver, once started: for commands the KV API does not cover (sets, sorted sets, pipelines). It bypasses namespace and the JSON codec. undefined with the memory driver or before start().

  Returns Redis | undefined

clear

• clear(prefix?: string): Promise<void>

  Deletes every key under prefix in this manager's namespace (the whole namespace without one). With the redis driver and no namespace, only flushDb: true lets it empty the database.

  Parameters

  • prefix: string = ''

  Returns Promise<void>

connect

• connect(): Promise<void>

  Returns Promise<void>

del

• del(key: string): Promise<void>

  Parameters

  • key: string

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

get

• get<T = unknown>(key: string): Promise<T | undefined>

  Type Parameters

  • T = unknown

  Parameters

  • key: string

  Returns Promise<T | undefined>

has

• has(key: string): Promise<boolean>

  Parameters

  • key: string

  Returns Promise<boolean>

init

• init(app: App): void

  Parameters

  • app: App

  Returns void

mdel

• mdel(keys: string[]): Promise<void>

  Parameters

  • keys: string[]

  Returns Promise<void>

mget

• mget<T = unknown>(keys: string[]): Promise<(T | undefined)[]>

  Type Parameters

  • T = unknown

  Parameters

  • keys: string[]

  Returns Promise<(T | undefined)[]>

mset

• mset<T = unknown>(
      entries: [string, T][] | Record<string, T>,
      ttl?: number,
  ): Promise<void>

  Type Parameters

  • T = unknown

  Parameters

  • entries: [string, T][] | Record<string, T>
  • Optionalttl: number

  Returns Promise<void>

sadd

• sadd(key: string, member: string, ttl?: number): Promise<void>

  See KVAdapter.sadd: the member is kept as is, only key is namespaced.

  Parameters

  • key: string
  • member: string
  • Optionalttl: number

  Returns Promise<void>

sdrain

• sdrain(key: string): Promise<string[]>

  Parameters

  • key: string

  Returns Promise<string[]>

set

• set<T = unknown>(key: string, value: T, ttl?: number): Promise<void>

  Type Parameters

  • T = unknown

  Parameters

  • key: string
  • value: T
  • Optionalttl: number

  Returns Promise<void>

start

• start(): Promise<void>

  Returns Promise<void>

stop

• stop(): Promise<void>

  Returns Promise<void>