Class MomentoStore

constructor

• new MomentoStore(options?: MomentoStoreOptions): MomentoStore

  Parameters

  • options: MomentoStoreOptions = {}

  Returns MomentoStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): MomentoCacheClient

  Returns the underlying Momento CacheClient for anything not wrapped here.

  Returns MomentoCacheClient

get

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

  Read a key from the configured cache. Returns the Momento response object.

  Parameters

  • key: string

  Returns Promise<any>

set

• set(key: string, value: unknown, options?: MomentoSetOptions): Promise<any>

  Write value under key. Strings are stored verbatim; other values are JSON-serialized. options.ttl sets a per-item TTL in seconds.

  Parameters

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

  Returns Promise<any>

del

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

  Delete a key from the configured cache.

  Parameters

  • key: string

  Returns Promise<any>

list

• list(listName?: string): Promise<any>

  Fetch the elements of a Momento list. Momento cannot enumerate cache keys, so prefix/listName names a list; defaults to defaultListName.

  Parameters

  • OptionallistName: string

  Returns Promise<any>

incr

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

  Atomically increment the numeric value at key by by (default 1).

  Parameters

  • key: string
  • by: number = 1

  Returns Promise<any>