FieldPath

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).

Create a FieldPath by providing field names. If more than one field name is provided, the path will point to a nested field in a document.

class FieldPath {

constructor(...fieldNames: string[]);

isEqual(other: FieldPath): boolean;

}

§Constructors

new FieldPath(...fieldNames: string[])

[src]

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.

§Methods

isEqual(other: FieldPath): boolean

[src]

Returns true if this FieldPath is equal to the provided one.

@param other

The FieldPath to compare against.

@return

true if this FieldPath is equal to the provided one.