Type Alias IndexDescription

Description of index(es) to be created on a store

type IndexDescription = {
    key: Record<string, IndexDirection>;
    multiEntry?: boolean;
    name?: string;
    unique?: boolean;
}

Index

Properties

key multiEntry? name? unique?

Properties

key

key: Record<string, IndexDirection>

The key(s) to index

`Optional`multiEntry

multiEntry?: boolean

Is the indexed value an array

`Optional`name

name?: string

The name of the index

`Optional`unique

unique?: boolean

If true, the index must enforce uniqueness on the key