Interface

IndexInfo

A description of an index, as returned by SinterCollection.indexes.

interface IndexInfo

Properties#

readonly direction: -1 | 1

1 for ascending or -1 for descending, for the first field.

readonly field: string

The first indexed field path. Use keys for a compound index.

readonly keys: readonly IndexKeyInfo[]

Every indexed field in order. One entry unless the index is compound.

readonly name: string

The index name.

readonly sparse: boolean

Whether documents without the field are left out of the index.

readonly unique: boolean

Whether the index rejects duplicate values.