KeyValueStoreClient

Key-value Store client.

Index

Methods

• delete
• deleteRecord
• get
• getRecord
• listKeys
• recordExists
• setRecord
• update

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>

recordExists

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

• Parameters

  • key: string

  Returns Promise<boolean>

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>>