IndexField

deprecated

A single field element in an index configuration.

@deprecated

Instead of creating cache indexes manually, consider using enablePersistentCacheIndexAutoCreation() to let the SDK decide whether to create cache indexes for queries running locally.

interface IndexField {

[key: string]: unknown;

readonly arrayConfig?: "CONTAINS";

readonly fieldPath: string;

readonly order?: "ASCENDING" | "DESCENDING";

}

§Index Signatures

[key: string]: unknown

§Properties

readonly arrayConfig?: "CONTAINS"

[src]

What type of array index to create. Set to CONTAINS for array-contains and array-contains-any indexes.

Only one of arrayConfig or order should be set;

readonly fieldPath: string

[src]

The field path to index.

readonly order?: "ASCENDING" | "DESCENDING"

[src]

What type of array index to create. Set to ASCENDING or 'DESCENDINGfor==, !=, <=, <=, inandnot-in` filters.

Only one of arrayConfig or order should be set.