Type alias HiddenIndex

HiddenIndex: (Index | InternalArangosearchIndex) & {
    progress?: number;
}

An object representing a potentially hidden index.

This type can be used to cast the result of collection.indexes to better reflect the actual data returned by the server when using the withHidden option:

const indexes = await collection.indexes<HiddenIndex>({
  withHidden: true
}));
// indexes may include internal indexes and indexes with a "progress"
// property

Type declaration

  • Optional progress?: number

    Progress of this index if it is still being created.

Settings

Theme