Daniel La RocqueandGitHub
d993a16712
* Change (BETA) annotation to (Public Preview) * format * Minor bump
3.0 KiB
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
IndexField interface
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Warning: This API is now obsolete.
Instead of creating cache indexes manually, consider using
enablePersistentCacheIndexAutoCreation()to let the SDK decide whether to create cache indexes for queries running locally.
A single field element in an index configuration.
Signature:
export declare interface IndexField
Properties
| Property | Type | Description |
|---|---|---|
| arrayConfig | 'CONTAINS' | (Public Preview) 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; |
| fieldPath | string | (Public Preview) The field path to index. |
| order | 'ASCENDING' | 'DESCENDING' | (Public Preview) What type of array index to create. Set to ASCENDING or 'DESCENDING for ==, !=, <=, <=, in and not-in` filters.Only one of arrayConfig or order should be set. |
IndexField.arrayConfig
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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;
Signature:
readonly arrayConfig?: 'CONTAINS';
IndexField.fieldPath
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The field path to index.
Signature:
readonly fieldPath: string;
IndexField.order
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
What type of array index to create. Set to ASCENDING or 'DESCENDINGfor==, !=, <=, <=, inandnot-in` filters.
Only one of arrayConfig or order should be set.
Signature:
readonly order?: 'ASCENDING' | 'DESCENDING';