Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateIndexDefinition

The definition of an index. This is used with createIndex when creating indexes.

Hierarchy

  • CreateIndexDefinition

Index

Properties

jsonPointer

jsonPointer: string

A JSON Ponter pointing at the sub value inside each value to index over.

For example, one might index over users' ages like so: createIndex({name: 'usersByAge', keyPrefix: '/user/', jsonPointer: '/age'})

Optional keyPrefix

keyPrefix: undefined | string

The prefix, if any, to limit the index over. If not provided the values of all keys are indexed.

name

name: string

The name of the index. This is used when you scan over an index.

Generated using TypeDoc