Class GeodeStore

constructor

• new GeodeStore(options?: GeodeStoreOptions): GeodeStore

  Parameters

  • options: GeodeStoreOptions = {}

  Returns GeodeStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): GeodeHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns GeodeHttpClient

getMap

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

  Resolve (and cache) a named-region handle.

  Parameters

  • name: string

  Returns Promise<GeodeRegion>

mapPut

• mapPut(map: GeodeRegion, key: string, value: unknown): Promise<void>

  Store value under key in map (PUT /geode/v1/<region>/<key>).

  Parameters

  • map: GeodeRegion
  • key: string
  • value: unknown

  Returns Promise<void>

mapGet

• mapGet(map: GeodeRegion, key: string): Promise<any>

  Read key from map (GET /geode/v1/<region>/<key>); null if absent.

  Parameters

  • map: GeodeRegion
  • key: string

  Returns Promise<any>

mapRemove

• mapRemove(map: GeodeRegion, key: string): Promise<any>

  Remove key from map (DELETE /geode/v1/<region>/<key>).

  Parameters

  • map: GeodeRegion
  • key: string

  Returns Promise<any>

mapKeys

• mapKeys(map: GeodeRegion): Promise<any[]>

  List all keys in map (GET /geode/v1/<region>/keys).

  Parameters

  • map: GeodeRegion

  Returns Promise<any[]>

mapSize

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

  Number of entries in map (derived from mapKeys).

  Parameters

  • map: GeodeRegion

  Returns Promise<number>