Class MemcachedStore

constructor

• new MemcachedStore(options?: MemcachedStoreOptions): MemcachedStore

  Parameters

  • options: MemcachedStoreOptions = {}

  Returns MemcachedStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

quit

• quit(): Promise<void>

  Alias for disconnect(), mirroring memjs's own quit()/close() naming.

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): MemjsClient

  Returns the underlying memjs client for anything not wrapped here.

  Returns MemjsClient

set

• set(
      key: string,
      value: unknown,
      options?: MemcachedWriteOptions,
  ): Promise<boolean>

  Store value under key, overwriting any existing value. Strings and Buffers are stored verbatim; other values are JSON-serialized (see serialize). Returns memjs's boolean success flag.

  Parameters

  • key: string
  • value: unknown
  • Optionaloptions: MemcachedWriteOptions

  Returns Promise<boolean>

get

• get(key: string, options?: MemcachedGetOptions): Promise<unknown>

  Read key. Returns null if the key is missing. By default returns the raw Buffer; pass { decode: 'string' } or { decode: 'json' } to decode the stored value.

  Parameters

  • key: string
  • options: MemcachedGetOptions = {}

  Returns Promise<unknown>

delete

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

  Delete key. Returns memjs's boolean success flag.

  Parameters

  • key: string

  Returns Promise<boolean>

add

• add(
      key: string,
      value: unknown,
      options?: MemcachedWriteOptions,
  ): Promise<boolean>

  Store value under key only if the key does not already exist (Memcached add). Returns false if the key was already present.

  Parameters

  • key: string
  • value: unknown
  • Optionaloptions: MemcachedWriteOptions

  Returns Promise<boolean>

replace

• replace(
      key: string,
      value: unknown,
      options?: MemcachedWriteOptions,
  ): Promise<boolean>

  Store value under key only if the key already exists (Memcached replace). Returns false if the key was missing.

  Parameters

  • key: string
  • value: unknown
  • Optionaloptions: MemcachedWriteOptions

  Returns Promise<boolean>

increment

• increment(
      key: string,
      amount: number,
      options?: MemcachedWriteOptions,
  ): Promise<{ value: number | null; success: boolean }>

  Atomically increment the numeric value at key by amount.

  Parameters

  • key: string
  • amount: number
  • Optionaloptions: MemcachedWriteOptions

  Returns Promise<{ value: number | null; success: boolean }>

decrement

• decrement(
      key: string,
      amount: number,
      options?: MemcachedWriteOptions,
  ): Promise<{ value: number | null; success: boolean }>

  Atomically decrement the numeric value at key by amount.

  Parameters

  • key: string
  • amount: number
  • Optionaloptions: MemcachedWriteOptions

  Returns Promise<{ value: number | null; success: boolean }>

flush

• flush(): Promise<unknown>

  Flush (delete) all keys across every configured server.

  Returns Promise<unknown>