IndexOptions

Defined in: packages/db/src/indexes/index-options.ts:6

Options for creating an index

Type Parameters#

TIndexType#

TIndexType extends IndexConstructor = IndexConstructor

Properties#

indexType?#

optional indexType: TIndexType;

Defined in: packages/db/src/indexes/index-options.ts:12

Index type to use (e.g., BasicIndex, BTreeIndex)

name?#

optional name: string;

Defined in: packages/db/src/indexes/index-options.ts:10

Optional name for the index

options?#

optional options: TIndexType extends (id, expr, name?, options?) => any ? O : never;

Defined in: packages/db/src/indexes/index-options.ts:14

Options passed to the index constructor