Global

Span names for instrumented operations.

Creates an expression that performs a logical 'AND' operation on multiple filter conditions.

// Check if the 'age' field is greater than 18 AND the 'city' field is "London" AND
// the 'status' field is "active"
const condition = and(greaterThan("age", 18), equal("city", "London"), equal("status", "active"));

Creates an expression that creates a Firestore array value from an input array.

// Create an array value from the input array and reference the 'baz' field value from the input document.
array(['bar', field('baz')]).as('foo');

Creates a conditional expression that evaluates to a 'then' expression if a condition is true and an 'else' expression if the condition is false.

// If 'age' is greater than 18, return "Adult"; otherwise, return "Minor".
conditional(
    greaterThan("age", 18), constant("Adult"), constant("Minor"));

Creates an aggregation that counts the total number of stage inputs.

// Count the total number of input documents
countAll().as("totalDocument");

Creates an aggregation that counts the number of distinct values of a field.

Creates an aggregation that counts the number of stage inputs where the provided boolean expression evaluates to true.

// Count the number of documents where 'is_active' field equals true
countIf(field("is_active").equal(true)).as("numActiveDocuments");

Creates an expression that represents the current document being processed.

Creates an expression that evaluates to the current server timestamp.

// Get the current server timestamp
currentTimestamp()

Detects the 'valueType' for cases where a map value has been used to represent another type.

Creates a Field instance representing the field at the given path.

The path can be a simple field name (e.g., "name") or a dot-separated path to a nested field (e.g., "address.city").

// Create a Field instance for the 'title' field
const titleField = field("title");

// Create a Field instance for a nested field 'author.firstName'
const authorFirstNameField = field("author.firstName");

Creates an expression that checks if a given expression produces an error.

// Check if the result of a calculation is an error
isError(field("title").arrayContains(1));

Returns true if value is a MapValue.

Checks if the given value is an instance of Temporal.Instant. Checks both instanceof against runtime Temporal.Instant (if available) and duck typing via [Symbol.toStringTag] and epochNanoseconds bigint property to support polyfills or cross-realm instances.

Creates an expression that creates a Firestore map value from an input object.

// Create a map from the input object and reference the 'baz' field value from the input document.
map({foo: 'bar', baz: field('baz')}).as('data');

Creates an expression that performs a logical 'NOR' operation on multiple filter conditions.

Creates an expression that negates a filter condition.

// Find documents where the 'completed' field is NOT true
not(equal("completed", true));

Creates an expression that performs a logical 'OR' operation on multiple filter conditions.

// Check if the 'age' field is greater than 18 OR the 'city' field is "London" OR
// the 'status' field is "active"
const condition = or(greaterThan("age", 18), equal("city", "London"), equal("status", "active"));

Creates an expression that generates a random number between 0.0 and 1.0 but not including 1.0.

Sets or disables the log function for all active Firestore instances.

Creates an expression that evaluates to the result corresponding to the first true condition.

Creates an expression that retrieves the value of a variable bound via define().

Creates an expression that performs a logical 'XOR' (exclusive OR) operation on multiple BooleanExprs.

// Check if only one of the conditions is true: 'age' greater than 18, 'city' is "London",
// or 'status' is "active".
const condition = xor(
    greaterThan("age", 18),
    equal("city", "London"),
    equal("status", "active"));

An error thrown when a BulkWriter operation fails.

The error used by BulkWriter~shouldRetryCallback set in BulkWriter#onWriteError.

An options object to configure throttling on BulkWriter.

Whether to disable or configure throttling. By default, throttling is enabled. throttling can be set to either a boolean or a config object. Setting it to true will use default values. You can override the defaults by setting it to false to disable throttling, or by setting the config values to enable throttling with the provided values.

Document data (e.g. for use with set()) consisting of fields mapped to values.

Converter used by withConverter() to transform user objects of type AppModelType into Firestore data of type DbModelType.

Using the converter allows you to specify generic type arguments when storing and retrieving objects from Firestore.

Status codes returned by GRPC operations.

An options object that configures conditional behavior of update() and delete() calls in DocumentReference, WriteBatch, BulkWriter, and Transaction. Using Preconditions, these calls can be restricted to only apply to documents that match the specified conditions.

An options object that can be used to configure the behavior of getAll() calls. By providing a fieldMask, these calls can be configured to only return a subset of fields.

An options object that configures the behavior of set() calls in DocumentReference, WriteBatch, and Transaction. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions object with { merge : true }.

Update data (for use with update) that contains paths mapped to values. Fields that contain dots reference nested fields within the document.

You can update a top-level field in your document by using the field name as a key (e.g. foo). The provided value completely replaces the contents for this field.

You can also update a nested field directly by using its field path as a key (e.g. foo.bar). This nested field update replaces the contents at bar but does not modify other data under foo.

onSnapshot() callback that receives a DocumentSnapshot.

onSnapshot() callback that receives an error.

onSnapshot() callback that receives a QuerySnapshot.