KeyValueClientListKeysOptions

Options for listing keys in a Key-Value Store.

Hierarchy

• TimeoutOptions
  • KeyValueClientListKeysOptions

Index

Properties

• chunkSize
• collection
• exclusiveStartKey
• limit
• prefix
• signal
• signature
• timeoutSecs

Properties

optionalchunkSize

chunkSize?: number

Maximum number of keys returned in one API response. When the call is iterated with for await, the iterator fetches keys in chunks of this size and yields them one by one, until limit is reached or the store has no more keys. Awaiting the call returns only the first chunk.

optionalcollection

collection?: string

optionalexclusiveStartKey

exclusiveStartKey?: string

optionallimit

limit?: number

optionalprefix

prefix?: string

Added in 2.12.5

optionalinheritedsignal

signal?: AbortSignal

Inherited from TimeoutOptions.signal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

optionalsignature

signature?: string

Added in 2.13.0

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Inherited from TimeoutOptions.timeoutSecs

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.