Class HazelcastStore

constructor

• new HazelcastStore(options?: HazelcastStoreOptions): HazelcastStore

  Parameters

  • options: HazelcastStoreOptions = {}

  Returns HazelcastStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): HazelcastClientLike

  Returns the underlying hazelcast-client client for anything not wrapped here.

  Returns HazelcastClientLike

getMap

• getMap(name: string): Promise<HazelcastMap>

  Resolve (and cache) a distributed IMap handle by name.

  Parameters

  • name: string

  Returns Promise<HazelcastMap>

mapPut

• mapPut(map: HazelcastMap, key: unknown, value: unknown): Promise<unknown>

  Put value under key in map, returning the previous value (or null).

  Parameters

  • map: HazelcastMap
  • key: unknown
  • value: unknown

  Returns Promise<unknown>

mapGet

• mapGet(map: HazelcastMap, key: unknown): Promise<unknown>

  Get the value stored under key in map (or null if absent).

  Parameters

  • map: HazelcastMap
  • key: unknown

  Returns Promise<unknown>

mapRemove

• mapRemove(map: HazelcastMap, key: unknown): Promise<unknown>

  Remove key from map, returning the removed value (or null).

  Parameters

  • map: HazelcastMap
  • key: unknown

  Returns Promise<unknown>

mapKeys

• mapKeys(map: HazelcastMap): Promise<unknown[]>

  Return all keys currently in map as an array.

  Parameters

  • map: HazelcastMap

  Returns Promise<unknown[]>

mapSize

• mapSize(map: HazelcastMap): Promise<number>

  Return the number of entries in map.

  Parameters

  • map: HazelcastMap

  Returns Promise<number>