Skip to main content
Version: Next

KeyValueStoreListKeysResult

A single page of keys returned by KeyValueStoreBackend.listKeys.

This mirrors PaginatedList (the shape returned by DatasetBackend.getData) so that both listing operations on the storage backend layer return a self-describing page. The difference is the pagination model: datasets are offset-based (total / offset), whereas key-value stores are cursor-based. A frontend assembling all pages should therefore not guess "is this the last page?" from items.length < limit — it should rely on isTruncated and resume from nextExclusiveStartKey.

Index

Properties

count

count: number

Number of keys returned on this page (items.length).

optionalexclusiveStartKey

exclusiveStartKey?: string

The exclusiveStartKey that produced this page, if any.

isTruncated

isTruncated: boolean

true if there are more keys beyond this page. When true, nextExclusiveStartKey is set.

items

Keys returned on this page.

limit

limit: number

Maximum number of keys requested for this page.

optionalnextExclusiveStartKey

nextExclusiveStartKey?: string

Cursor to pass as the next call's exclusiveStartKey, or undefined when isTruncated is false.