Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScanOptions

Hierarchy

  • ScanOptions

Index

Properties

Optional indexName

indexName: undefined | string

Do a scan over a named index.

Optional limit

limit: undefined | number

Only include up to limit results.

Optional prefix

prefix: undefined | string

Only include keys starting with prefix.

Optional startKey

startKey: undefined | string

The first key to include in the result. If startKeyExclusive is true then this key is not included and the result start withthe next larger key.

Optional startKeyExclusive

startKeyExclusive: undefined | false | true

Whether the startKey is exclusive or inclusive.

Generated using TypeDoc