Skip to main content

Interface: ScanResult<K, V>

Extends​

  • AsyncIterable<V>

Type Parameters​

K​

K extends ScanKey

V​

V

Methods​

[asyncIterator]()​

[asyncIterator](): AsyncIterableIteratorToArray<V>

The default AsyncIterable. This is the same as values.

Returns​

AsyncIterableIteratorToArray<V>

Overrides​

AsyncIterable.[asyncIterator]


entries()​

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

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, V]>


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<V[]>

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

Returns​

Promise<V[]>


values()​

values(): AsyncIterableIteratorToArray<V>

Async iterator over the values of the scan call.

Returns​

AsyncIterableIteratorToArray<V>