KeyValueStoreClient

Key-value Store client.

Index

Methods

• delete
• deleteRecord
• entries
• get
• getRecord
• keys
• listKeys
• recordExists
• setRecord
• update
• values

Methods

delete

• delete(): Promise<void>

• Returns Promise<void>

deleteRecord

• deleteRecord(key): Promise<void>

• Parameters

  • key: string

  Returns Promise<void>

optionalentries

• entries(options): AsyncIterable<[string, unknown], any, any> & Promise<[string, unknown][]>

• Parameters

  • optionaloptions: KeyValueStoreClientListOptions

  Returns AsyncIterable<[string, unknown], any, any> & Promise<[string, unknown][]>

get

• get(): Promise<undefined | KeyValueStoreInfo>

• Returns Promise<undefined | KeyValueStoreInfo>

getRecord

• getRecord(key, options): Promise<undefined | KeyValueStoreRecord>

• Parameters

  • key: string

  • optionaloptions: KeyValueStoreClientGetRecordOptions

  Returns Promise<undefined | KeyValueStoreRecord>

optionalkeys

• keys(options): AsyncIterable<string, any, any> & Promise<KeyValueStoreClientListData>

• Parameters

  • optionaloptions: KeyValueStoreClientListOptions

  Returns AsyncIterable<string, any, any> & Promise<KeyValueStoreClientListData>

listKeys

• listKeys(options): Partial<AsyncIterable<KeyValueStoreItemData, any, any>> & Promise<KeyValueStoreClientListData>

• Parameters

  • optionaloptions: KeyValueStoreClientListOptions

  Returns Partial<AsyncIterable<KeyValueStoreItemData, any, any>> & Promise<KeyValueStoreClientListData>

recordExists

• recordExists(key): Promise<boolean>

• Parameters

  • key: string

  Returns Promise<boolean>

setRecord

• setRecord(record, options): Promise<void>

• Parameters

  • record: KeyValueStoreRecord

  • optionaloptions: KeyValueStoreRecordOptions

  Returns Promise<void>

update

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

• Parameters

  • newFields: KeyValueStoreClientUpdateOptions

  Returns Promise<Partial<KeyValueStoreInfo>>

optionalvalues

• values(options): AsyncIterable<unknown, any, any> & Promise<unknown[]>

• Parameters

  • optionaloptions: KeyValueStoreClientListOptions

  Returns AsyncIterable<unknown, any, any> & Promise<unknown[]>