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.

Index

Constructors

Methods

Constructors

constructor

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

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

    Parameters

    • Rest ...fieldNames: string[]

      A list of field names.

    Returns FieldPath

Methods

isEqual

  • isEqual ( other :  FieldPath ) : boolean

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

    Parameters

    • other: FieldPath

      The FieldPath to compare against.

    Returns boolean

    true if this FieldPath is equal to the provided one.

Static documentId

  • documentId ( ) : FieldPath

  • Returns a special sentinel FieldPath to refer to the ID of a document. It can be used in queries to sort or filter by the document ID.

    Returns FieldPath