@firebase/firestore
Version:
The Cloud Firestore component of the Firebase JS SDK.
37 lines (36 loc) • 1.52 kB
TypeScript
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FieldPath as PublicFieldPath } from '@firebase/firestore-types';
import { Compat } from '@firebase/util';
import { FieldPath as ExpFieldPath } from '../../exp/index';
/**
* A `FieldPath` refers to a field in a document. The path may consist of a
* single field name (referring to a top-level field in the document), or a list
* of field names (referring to a nested field in the document).
*/
export declare class FieldPath implements PublicFieldPath, Compat<ExpFieldPath> {
readonly _delegate: ExpFieldPath;
/**
* Creates a FieldPath from the provided field names. If more than one field
* name is provided, the path will point to a nested field in a document.
*
* @param fieldNames - A list of field names.
*/
constructor(...fieldNames: string[]);
static documentId(): FieldPath;
isEqual(other: PublicFieldPath): boolean;
}