Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

  • internal

    Type parameters

    • K

    Parameters

    • Rest ...args: Args

    Returns ScanResult<K>

Methods

[Symbol.asyncIterator]

  • [Symbol.asyncIterator](): AsyncIterableIterator<JSONValue>
  • The default AsyncIterable. This is the same as values.

    Returns AsyncIterableIterator<JSONValue>

entries

  • entries(): AsyncIterableIterator<[K, JSONValue]>
  • 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>
  • 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

  • Async iterator over the valus of the scan call.

    Returns AsyncIterableIterator<JSONValue>

Generated using TypeDoc