Skip to main content

Interface: ScanResult<K>

Type parameters

NameType
Kextends ScanKey

Hierarchy

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIteratorToArray<ReadonlyJSONValue>

The default AsyncIterable. This is the same as values.

Returns

AsyncIterableIteratorToArray<ReadonlyJSONValue>

Overrides

AsyncIterable.__@asyncIterator@21452


entries

entries(): AsyncIterableIteratorToArray<readonly [K, ReadonlyJSONValue]>

Async iterator over the entries of the scan call. An entry is a tuple of key values. If the scan is over an index the key is a tuple of [secondaryKey: string, primaryKey]

Returns

AsyncIterableIteratorToArray<readonly [K, ReadonlyJSONValue]>


keys

keys(): AsyncIterableIteratorToArray<K>

Async iterator over the keys of the scan call. If the scan is over an index the key is a tuple of [secondaryKey: string, primaryKey]

Returns

AsyncIterableIteratorToArray<K>


toArray

toArray(): Promise<ReadonlyJSONValue[]>

Returns all the values as an array. Same as values().toArray()

Returns

Promise<ReadonlyJSONValue[]>


values

values(): AsyncIterableIteratorToArray<ReadonlyJSONValue>

Async iterator over the values of the scan call.

Returns

AsyncIterableIteratorToArray<ReadonlyJSONValue>