Field class

Represents a reference to a field in a Firestore document, or outputs of a Pipeline stage.

Field references are used to access document field values in expressions and to specify fields for sorting, filtering, and projecting data in Firestore pipelines.

You can create a Field instance using the static method:

Signature:

export declare class Field extends Expression implements Selectable 

Extends: Expression

Implements: Selectable

Properties

Methods

Field.alias

Signature:

get alias(): string;

Field.expr

Signature:

get expr(): Expression;

Field.expressionType

Signature:

readonly expressionType: ExpressionType;

Field.fieldName

Signature:

get fieldName(): string;

Field.selectable

Signature:

selectable: true;

Field.geoDistance()

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.

Evaluates to the distance in meters between the location specified by this field and the query location.

This Expression can only be used within a Search stage.

Signature:

geoDistance(location: GeoPoint | Expression): Expression;

Parameters

Returns:

Expression

Example

// Create a Field instance for the 'name' field
const nameField = field("name");

// Create a Field instance for a nested field 'address.city'
const cityField = field("address.city");