Class DaxStore

constructor

• new DaxStore(options?: DaxStoreOptions): DaxStore

  Parameters

  • options: DaxStoreOptions = {}

  Returns DaxStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): DaxClient

  Returns the underlying DAX (DynamoDB-compatible) client for anything not wrapped here.

  Returns DaxClient

get

• get(key: string): Promise<string | null>

  Read a key via getItem. Returns the stored string, or null if missing.

  Parameters

  • key: string

  Returns Promise<string | null>

set

• set(key: string, value: unknown, options?: DaxSetOptions): Promise<void>

  Write value under key via putItem. Strings are stored verbatim; other values are JSON-serialized. options.ttl/options.expiration populate the table's TTL attribute (ttlAttr).

  Parameters

  • key: string
  • value: unknown
  • options: DaxSetOptions = {}

  Returns Promise<void>

del

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

  Delete a key via deleteItem.

  Parameters

  • key: string

  Returns Promise<void>

list

• list(prefix?: string): Promise<string[]>

  List key names via scan, optionally filtered to those beginning with prefix.

  Parameters

  • Optionalprefix: string

  Returns Promise<string[]>

incr

• incr(key: string, by?: number): Promise<number>

  Increment the numeric value at key by by (default 1). Implemented as a non-atomic read-modify-write over getItem/putItem.

  Parameters

  • key: string
  • by: number = 1

  Returns Promise<number>