Skip to main content
Version: 3.5

KeyValueStoreClient

Key-value Store client.

Index

Methods

delete

  • delete(): Promise<void>
  • Returns Promise<void>

deleteRecord

  • deleteRecord(key: string): Promise<void>
  • Parameters

    • key: string

    Returns Promise<void>

get

  • get(): Promise<undefined | KeyValueStoreInfo>
  • Returns Promise<undefined | KeyValueStoreInfo>

getRecord

  • getRecord(key: string, options?: KeyValueStoreClientGetRecordOptions): Promise<undefined | KeyValueStoreRecord>
  • Parameters

    • key: string
    • optionaloptions: KeyValueStoreClientGetRecordOptions

    Returns Promise<undefined | KeyValueStoreRecord>

listKeys

  • listKeys(options?: KeyValueStoreClientListOptions): Promise<KeyValueStoreClientListData>
  • Parameters

    • optionaloptions: KeyValueStoreClientListOptions

    Returns Promise<KeyValueStoreClientListData>

setRecord

  • setRecord(record: KeyValueStoreRecord): Promise<void>
  • Parameters

    • record: KeyValueStoreRecord

    Returns Promise<void>

update

  • update(newFields: KeyValueStoreClientUpdateOptions): Promise<Partial<KeyValueStoreInfo>>
  • Parameters

    • newFields: KeyValueStoreClientUpdateOptions

    Returns Promise<Partial<KeyValueStoreInfo>>