Class ScanResult<K>

This class is used for the results of scan. It implements AsyncIterable<JSONValue> which allows you to use it in a for await loop. There are also methods to iterate over the keys, entries or values.

Type parameters

K

Hierarchy

ScanResult

Implements

AsyncIterable<JSONValue>

Index

Constructors

constructor

Methods

Constructors

constructor

new ScanResult<K>(...args: Args): ScanResult<K>

- Defined in scan-iterator.ts:31
internal

Type parameters
- K
Parameters
- Rest ...args: Args
Returns ScanResult<K>

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterableIterator<JSONValue>

- Defined in scan-iterator.ts:39
The default AsyncIterable. This is the same as values.

Returns AsyncIterableIterator<JSONValue>

entries

entries(): AsyncIterableIterator<[K, JSONValue]>

- Defined in scan-iterator.ts:63
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 AsyncIterableIterator<[K, JSONValue]>

keys

keys(): AsyncIterableIterator<K>

- Defined in scan-iterator.ts:53
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 AsyncIterableIterator<K>

values

values(): AsyncIterableIterator<JSONValue>

- Defined in scan-iterator.ts:44
Async iterator over the valus of the scan call.

Returns AsyncIterableIterator<JSONValue>

Generated using TypeDoc