Type alias IndexDescriptionType<Type, Fields, Extra>

IndexDescriptionType<Type, Fields, Extra>: {
    fields: Fields;
    figures?: Record<string, any>;
    id: string;
    name: string;
    sparse: boolean;
    type: Type;
    unique: boolean;
} & Extra

Shared attributes of all index types.

Type Parameters

  • Type extends string
  • Fields extends any[]
  • Extra extends {} = {}

Type declaration

  • fields: Fields

    An array of attribute paths.

  • Optional figures?: Record<string, any>

    Additional stats about this index.

  • id: string

    A unique identifier for this index.

  • name: string

    A unique name for this index.

  • sparse: boolean

    Whether documents not containing at least one of the attribute paths are omitted by this index.

  • type: Type

    Type of this index.

  • unique: boolean

    Whether this index enforces uniqueness for values of its attribute paths.

Settings

Theme