IndexReader

ts

type IndexReader<TKey> = Pick<IndexInterface<TKey>, 
  | "lookup"
  | "rangeQuery"
  | "take"
  | "takeFromStart"
  | "keyCount"
  | "supports"
  | "supportsRangeOptimization"
  | "supportsOrderOptimization"
| "canOptimizeRangeFor">;

Defined in: packages/db/src/indexes/base-index.ts:61

The read-side surface consumers use on a resolved (possibly reversed) index.

Type Parameters

TKey

TKey extends string | number = string | number

NextCore API Reference