diff --git a/api-report/firestore.api.md b/api-report/firestore.api.md index 59326707a..8054762fb 100644 --- a/api-report/firestore.api.md +++ b/api-report/firestore.api.md @@ -14,33 +14,15 @@ import * as protos from '../../protos/firestore_v1_proto_api'; import { Readable } from 'stream'; import { Span as Span_2 } from '@opentelemetry/api'; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function abs(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function abs(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function add(first: Expression, second: Expression | unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function add(fieldName: string, second: Expression | unknown): FunctionExpression; @@ -61,15 +43,11 @@ export class Aggregate { export class AggregateField implements firestore.AggregateField { // (undocumented) readonly aggregateType: AggregateType; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen static average(field: string | FieldPath): AggregateField; static count(): AggregateField; // @internal readonly _field?: string | FieldPath; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: AggregateField): boolean; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen static sum(field: string | FieldPath): AggregateField; readonly type = "AggregateField"; } @@ -82,8 +60,6 @@ export type AggregateFieldType = ReturnType | Retur // @beta class AggregateFunction implements AggregateFunction, HasUserData { constructor(name: string, params: Expression[]); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration as(name: string): AliasedAggregate; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration _createdFromLiteral: boolean; @@ -104,29 +80,20 @@ class AggregateFunction implements AggregateFunction, HasUserData { // @public export class AggregateQuery implements firestore.AggregateQuery { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // // @internal constructor(_query: Query, _aggregates: AggregateSpecType); - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration explain(options?: firestore.ExplainOptions): Promise>>; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration get(): Promise>; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (ae-forgotten-export) The symbol "QuerySnapshotResponse" needs to be exported by the entry point index.d.ts // // @internal _get(transactionOrReadTime?: Uint8Array | Timestamp | api.ITransactionOptions): Promise>>; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (ae-forgotten-export) The symbol "QueryResponse" needs to be exported by the entry point index.d.ts // // @internal _getResponse(transactionOrReadTime?: Uint8Array | Timestamp | api.ITransactionOptions, explainOptions?: firestore.ExplainOptions): Promise>>; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: firestore.AggregateQuery): boolean; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // @@ -134,8 +101,6 @@ export class AggregateQuery; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal _stream(transactionOrReadTime?: Uint8Array | Timestamp | api.ITransactionOptions, explainOptions?: firestore.ExplainOptions): Readable; @@ -147,15 +112,9 @@ export class AggregateQuery implements firestore.AggregateQuerySnapshot { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // // @internal constructor(_query: AggregateQuery, _readTime: Timestamp, _data: firestore.AggregateSpecData); data(): firestore.AggregateSpecData; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: firestore.AggregateQuerySnapshot): boolean; get query(): AggregateQuery; get readTime(): Timestamp; @@ -204,259 +163,106 @@ class AliasedExpression implements firestore.Pipelines.Selectable, HasUserData { _validateUserData(ignoreUndefinedProperties: boolean): void; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function and(first: BooleanExpression, second: BooleanExpression, ...more: BooleanExpression[]): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function array(elements: unknown[]): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayConcat(firstArray: Expression, secondArray: Expression | unknown[], ...otherArrays: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayConcat(firstArrayField: string, secondArray: Expression | unknown[], ...otherArrays: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContains(array: Expression, element: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContains(array: Expression, element: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContains(fieldName: string, element: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContains(fieldName: string, element: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContainsAll(array: Expression, values: Array): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContainsAll(fieldName: string, values: Array): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContainsAll(array: Expression, arrayExpression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContainsAll(fieldName: string, arrayExpression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContainsAny(array: Expression, values: Array): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContainsAny(fieldName: string, values: Array): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContainsAny(array: Expression, values: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayContainsAny(fieldName: string, values: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function arrayGet(arrayField: string, index: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function arrayGet(arrayField: string, indexExpr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function arrayGet(arrayExpression: Expression, index: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function arrayGet(arrayExpression: Expression, indexExpr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayLength(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayLength(array: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayReverse(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function arrayReverse(arrayExpression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function arraySum(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function arraySum(expression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function ascending(expr: Expression): Ordering; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function ascending(fieldName: string): Ordering; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function average(expression: Expression): AggregateFunction; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function average(fieldName: string): AggregateFunction; // @beta abstract class BooleanExpression extends Expression implements firestore.Pipelines.BooleanExpression { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration conditional(thenExpr: Expression, elseExpr: Expression): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration countIf(): AggregateFunction; // (undocumented) abstract get _expr(): Expression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration ifError(catchValue: BooleanExpression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration ifError(catchValue: boolean): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration ifError(catchValue: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration ifError(catchValue: unknown): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration not(): BooleanExpression; // (undocumented) _toProto(serializer: Serializer): api.IValue; @@ -472,20 +278,15 @@ export class BulkWriter { constructor(firestore: Firestore, options?: firestore.BulkWriterOptions); // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration close(): Promise; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" create(documentRef: firestore.DocumentReference, data: firestore.WithFieldValue): Promise; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -496,16 +297,13 @@ export class BulkWriter { delete(documentRef: firestore.DocumentReference, precondition?: firestore.Precondition): Promise; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration flush(): Promise; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // // @internal (undocumented) _getBufferedOperationsCount(): number; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' onWriteError(shouldRetryCallback: (error: BulkWriterError) => boolean): void; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' onWriteResult(successCallback: (documentRef: firestore.DocumentReference, result: WriteResult) => void): void; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration @@ -531,9 +329,7 @@ export class BulkWriter { // // @internal (undocumented) _setMaxPendingOpCount(newMax: number): void; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag @@ -582,45 +378,21 @@ export class BundleBuilder { readonly bundleId: string; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function byteLength(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function byteLength(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function ceil(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function ceil(expression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function charLength(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function charLength(stringExpression: Expression): FunctionExpression; @@ -630,31 +402,19 @@ function charLength(stringExpression: Expression): FunctionExpression; export class CollectionGroup extends Query implements firestore.CollectionGroup { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration constructor(firestore: Firestore, collectionId: string, converter: firestore.FirestoreDataConverter | undefined); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration getPartitions(desiredPartitionCount: number): AsyncIterable>; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration withConverter(converter: firestore.FirestoreDataConverter | null): CollectionGroup; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function collectionId(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function collectionId(expression: Expression): FunctionExpression; @@ -664,11 +424,8 @@ function collectionId(expression: Expression): FunctionExpression; // @public export class CollectionReference extends Query implements firestore.CollectionReference { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (ae-forgotten-export) The symbol "ResourcePath" needs to be exported by the entry point index.d.ts constructor(firestore: Firestore, path: ResourcePath, converter?: firestore.FirestoreDataConverter); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -684,15 +441,12 @@ export class CollectionReference): boolean; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration listDocuments(): Promise>>; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -714,28 +468,12 @@ export class CollectionReference; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function concat(first: Expression, second: Expression | unknown, ...others: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function concat(fieldName: string, second: Expression | unknown, ...others: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function conditional(condition: BooleanExpression, thenExpr: Expression, elseExpr: Expression): FunctionExpression; @@ -743,7 +481,6 @@ function conditional(condition: BooleanExpression, thenExpr: Expression, elseExp class Constant extends Expression { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // Warning: (tsdoc-undefined-tag) The TSDoc tag "@hideconstructor" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen constructor(value: unknown); // (undocumented) readonly expressionType: firestore.Pipelines.ExpressionType; @@ -761,142 +498,73 @@ class Constant extends Expression { _validateUserData(ignoreUndefinedProperties: boolean): void; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: number): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: string): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: boolean): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: null): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: firestore.GeoPoint): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: firestore.Timestamp): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: Date): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: Buffer | Uint8Array): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: firestore.DocumentReference): Expression; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // // @beta function constant(value: api.IValue): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function constant(value: firestore.VectorValue): Expression; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @beta (undocumented) function constant(value: unknown): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function cosineDistance(fieldName: string, vector: number[] | VectorValue): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function cosineDistance(fieldName: string, vectorExpression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function cosineDistance(vectorExpression: Expression, vector: number[] | VectorValue): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function cosineDistance(vectorExpression: Expression, otherVectorExpression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function count(expression: Expression): AggregateFunction; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function count(fieldName: string): AggregateFunction; -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function countAll(): AggregateFunction; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function countDistinct(expr: Expression | string): AggregateFunction; // @beta function countIf(booleanExpr: BooleanExpression): AggregateFunction; -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function currentTimestamp(): FunctionExpression; @@ -908,47 +576,21 @@ export const DEFAULT_MAX_IDLE_CHANNELS = 1; // @public export const DEFAULT_MAX_TRANSACTION_ATTEMPTS = 5; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function descending(expr: Expression): Ordering; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function descending(fieldName: string): Ordering; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function divide(dividend: Expression, divisort: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function divide(dividend: Expression, divisor: unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function divide(dividend: string, divisor: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function divide(dividend: string, divisor: unknown): FunctionExpression; @@ -957,13 +599,9 @@ function divide(dividend: string, divisor: unknown): FunctionExpression; // @public export class DocumentChange implements firestore.DocumentChange { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' constructor(type: DocumentChangeType, document: QueryDocumentSnapshot, oldIndex: number, newIndex: number); // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag @@ -971,9 +609,7 @@ export class DocumentChange; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: firestore.DocumentChange): boolean; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -995,15 +631,9 @@ export class DocumentChange implements Serializable, firestore.DocumentReference { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal constructor(_firestore: Firestore, _path: ResourcePath, _converter?: firestore.FirestoreDataConverter); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -1030,14 +656,12 @@ export class DocumentReference; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" create(data: firestore.WithFieldValue): Promise; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -1071,18 +695,14 @@ export class DocumentReference): boolean; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" listCollections(): Promise>; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -1113,9 +733,7 @@ export class DocumentReference implements firestore.DocumentSnapshot { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal constructor(ref: DocumentReference, @@ -1159,9 +772,6 @@ export class DocumentSnapshot(ref: DocumentReference, obj: firestore.DocumentData): DocumentSnapshot; @@ -1172,14 +782,10 @@ export class DocumentSnapshot(ref: firestore.DocumentReference, data: UpdateMap): DocumentSnapshot; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -1189,14 +795,11 @@ export class DocumentSnapshot): boolean; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal protoField(field: string | FieldPath): api.IValue | undefined; @@ -1225,159 +828,63 @@ export class DocumentSnapshot): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function equalAny(expression: Expression, arrayExpression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function equalAny(fieldName: string, values: Array): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function equalAny(fieldName: string, arrayExpression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function euclideanDistance(fieldName: string, vector: number[] | VectorValue): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function euclideanDistance(fieldName: string, vectorExpression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function euclideanDistance(vectorExpression: Expression, vector: number[] | VectorValue): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function euclideanDistance(vectorExpression: Expression, otherVectorExpression: Expression): FunctionExpression; @@ -1403,29 +910,15 @@ export class ExecutionStats implements firestore.ExecutionStats { readonly resultsReturned: number; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function exists(value: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function exists(fieldName: string): BooleanExpression; -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function exp(expression: Expression): FunctionExpression; -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function exp(fieldName: string): FunctionExpression; @@ -1463,393 +956,146 @@ export class ExplainResults implements firestore.ExplainResults { // @beta abstract class Expression implements firestore.Pipelines.Expression, HasUserData { - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration abs(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration add(second: firestore.Pipelines.Expression | unknown, ...others: Array): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayConcat(secondArray: Expression | unknown[], ...otherArrays: Array): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayContains(expression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayContains(value: unknown): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayContainsAll(values: Array): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayContainsAll(arrayExpression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayContainsAny(values: Array): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayContainsAny(arrayExpression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayGet(index: number): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayGet(indexExpr: Expression): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration arrayLength(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration arrayReverse(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration arraySum(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration as(name: string): AliasedExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration asBoolean(): BooleanExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration ascending(): Ordering; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration average(): AggregateFunction; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration byteLength(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration ceil(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration charLength(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration collectionId(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration concat(second: Expression | unknown, ...others: Array): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration cosineDistance(vectorExpression: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration cosineDistance(vector: firestore.VectorValue | number[]): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration count(): AggregateFunction; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration countDistinct(): AggregateFunction; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration _createdFromLiteral: boolean; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration descending(): Ordering; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration divide(divisor: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration divide(divisor: number): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration documentId(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration dotProduct(vectorExpression: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration dotProduct(vector: firestore.VectorValue | number[]): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration endsWith(suffix: string): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration endsWith(suffix: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration equal(expression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration equal(value: unknown): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration equalAny(values: Array): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration equalAny(arrayExpression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration euclideanDistance(vectorExpression: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration euclideanDistance(vector: firestore.VectorValue | number[]): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration exists(): BooleanExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration exp(): FunctionExpression; // (undocumented) abstract expressionType: firestore.Pipelines.ExpressionType; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration floor(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration greaterThan(expression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration greaterThan(value: unknown): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration greaterThanOrEqual(expression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration greaterThanOrEqual(value: unknown): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration ifAbsent(elseValue: unknown): Expression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration ifAbsent(elseExpression: unknown): Expression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration ifError(catchExpr: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration ifError(catchValue: unknown): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration isAbsent(): BooleanExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration isError(): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration join(delimiterExpression: Expression): Expression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration join(delimiter: string): Expression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration length(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration lessThan(experession: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration lessThan(value: unknown): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration lessThanOrEqual(expression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration lessThanOrEqual(value: unknown): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration like(pattern: string): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration like(pattern: Expression): BooleanExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration ln(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration log10(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration logicalMaximum(second: Expression | unknown, ...others: Array): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration logicalMinimum(second: Expression | unknown, ...others: Array): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration mapGet(subfield: string): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration mapMerge(secondMap: Record | Expression, ...otherMaps: Array | Expression>): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration mapRemove(key: string): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration mapRemove(keyExpr: Expression): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration maximum(): AggregateFunction; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration minimum(): AggregateFunction; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration mod(expression: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration mod(value: number): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration multiply(second: Expression | number, ...others: Array): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration notEqual(expression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration notEqual(value: unknown): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration notEqualAny(values: Array): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration notEqualAny(arrayExpression: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration pow(exponent: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration pow(exponent: number): FunctionExpression; // (undocumented) _protoValueType: "ProtoValue"; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration regexContains(pattern: string): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration regexContains(pattern: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration regexMatch(pattern: string): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration regexMatch(pattern: Expression): BooleanExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration reverse(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration round(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration round(decimalPlaces: number): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration round(decimalPlaces: Expression): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration split(delimiter: string): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration split(delimiter: Expression): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration sqrt(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration startsWith(prefix: string): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration startsWith(prefix: Expression): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration stringConcat(secondString: Expression | string, ...otherStrings: Array): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration stringContains(substring: string): BooleanExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration stringContains(expr: Expression): BooleanExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration stringReverse(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen substring(position: number, length?: number): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen substring(position: Expression, length?: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration subtract(subtrahend: firestore.Pipelines.Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration subtract(subtrahend: number): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration sum(): AggregateFunction; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration timestampAdd(unit: Expression, amount: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration timestampAdd(unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day', amount: number): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration timestampSubtract(unit: Expression, amount: Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration timestampSubtract(unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day', amount: number): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration timestampToUnixMicros(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration timestampToUnixMillis(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration timestampToUnixSeconds(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration timestampTruncate(granularity: firestore.Pipelines.TimeGranularity, timezone?: string | Expression): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration timestampTruncate(granularity: Expression, timezone?: string | Expression): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration toLower(): FunctionExpression; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // // (undocumented) abstract _toProto(serializer: Serializer): api.IValue; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration toUpper(): FunctionExpression; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration trim(valueToTrim?: string | Expression | Uint8Array | Buffer): FunctionExpression; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration type(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration unixMicrosToTimestamp(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration unixMillisToTimestamp(): FunctionExpression; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration unixSecondsToTimestamp(): FunctionExpression; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // // (undocumented) abstract _validateUserData(ignoreUndefinedProperties: boolean): void; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration vectorLength(): FunctionExpression; } @@ -1857,7 +1103,6 @@ abstract class Expression implements firestore.Pipelines.Expression, HasUserData class Field extends Expression implements firestore.Pipelines.Selectable { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // Warning: (tsdoc-undefined-tag) The TSDoc tag "@hideconstructor" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen constructor(fieldPath: FieldPath); // (undocumented) get _alias(): string; @@ -1879,11 +1124,6 @@ class Field extends Expression implements firestore.Pipelines.Selectable { _validateUserData(_: boolean): void; } -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function field(field: string | firestore.FieldPath): Field; @@ -1892,11 +1132,9 @@ function field(field: string | firestore.FieldPath): Field; // // @public export class FieldPath extends Path implements firestore.FieldPath { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' constructor(...segments: string[]); // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal @override construct(segments: string[]): FieldPath; @@ -1916,25 +1154,21 @@ export class FieldPath extends Path implements firestore.FieldPath { // @internal @override get formattedName(): string; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" // // @internal static fromArgument(fieldPath: string | firestore.FieldPath): FieldPath; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: FieldPath): boolean; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // // @internal get _minNumSegments(): number; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -1953,59 +1187,45 @@ export class FieldPath extends Path implements firestore.FieldPath { export class FieldValue implements firestore.FieldValue { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration constructor(); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration static arrayRemove(...elements: unknown[]): FieldValue; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration static arrayUnion(...elements: unknown[]): FieldValue; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" static delete(): FieldValue; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration static increment(n: number): FieldValue; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: firestore.FieldValue): boolean; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration static serverTimestamp(): FieldValue; static vector(values?: number[]): VectorValue; } // @public export abstract class Filter { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" static and(...filters: Filter[]): Filter; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" static or(...filters: Filter[]): Filter; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2016,7 +1236,6 @@ export abstract class Filter { // // @public class Firestore implements firestore.Firestore { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2056,19 +1275,16 @@ class Firestore implements firestore.Firestore { // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" batch(): WriteBatch; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" bulkWriter(options?: firestore.BulkWriterOptions): BulkWriter; // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters bundle(name?: string): BundleBuilder; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" collection(collectionPath: string): CollectionReference; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2078,7 +1294,6 @@ class Firestore implements firestore.Firestore { // // @internal _decrementBulkWritersCount(): void; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2087,7 +1302,6 @@ class Firestore implements firestore.Firestore { // // @internal get formattedName(): string; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2097,8 +1311,6 @@ class Firestore implements firestore.Firestore { // @internal _incrementBulkWritersCount(): void; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // // @internal initializeIfNeeded(requestTag: string): Promise; @@ -2111,9 +1323,6 @@ class Firestore implements firestore.Firestore { // // @internal get projectId(): string; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration recursiveDelete(ref: firestore.CollectionReference | firestore.DocumentReference, bulkWriter?: BulkWriter): Promise; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // @@ -2124,27 +1333,17 @@ class Firestore implements firestore.Firestore { // @internal registerListener(): void; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (ae-forgotten-export) The symbol "FirestoreUnaryMethod" needs to be exported by the entry point index.d.ts // // @internal request(methodName: FirestoreUnaryMethod, request: Req, requestTag: string, retryCodes?: number[]): Promise; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (ae-forgotten-export) The symbol "FirestoreStreamingMethod" needs to be exported by the entry point index.d.ts // // @internal requestStream(methodName: FirestoreStreamingMethod, bidrectional: boolean, request: {}, requestTag: string): Promise; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@template" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2153,7 +1352,6 @@ class Firestore implements firestore.Firestore { // // @internal _serializer: Serializer | null; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' settings(settings: firestore.Settings): void; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration @@ -2161,9 +1359,6 @@ class Firestore implements firestore.Firestore { // @internal _settings: firestore.Settings; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen snapshot_(documentName: string, readTime?: google.protobuf.ITimestamp, encoding?: 'protobufJS'): DocumentSnapshot; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // @@ -2179,9 +1374,7 @@ class Firestore implements firestore.Firestore { snapshot_(document: { [k: string]: unknown; }, readTime: string, encoding: 'json'): QueryDocumentSnapshot; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration terminate(): Promise; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration toJSON(): object; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // Warning: (ae-forgotten-export) The symbol "TraceUtil" needs to be exported by the entry point index.d.ts @@ -2196,17 +1389,9 @@ class Firestore implements firestore.Firestore { export { Firestore } export default Firestore; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function floor(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function floor(fieldName: string): FunctionExpression; @@ -2231,20 +1416,16 @@ class FunctionExpression extends Expression { // // @public export class GeoPoint implements Serializable, firestore.GeoPoint { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' constructor(latitude: number, longitude: number); // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // // @internal static fromProto(proto: google.type.ILatLng): GeoPoint; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: firestore.GeoPoint): boolean; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2262,381 +1443,162 @@ export class GeoPoint implements Serializable, firestore.GeoPoint { toProto(): api.IValue; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function greaterThan(left: Expression, right: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function greaterThan(expression: Expression, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function greaterThan(fieldName: string, expression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function greaterThan(fieldName: string, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function greaterThanOrEqual(left: Expression, right: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function greaterThanOrEqual(expression: Expression, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function greaterThanOrEqual(fieldName: string, value: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function greaterThanOrEqual(fieldName: string, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function ifAbsent(ifExpr: Expression, elseExpr: Expression): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function ifAbsent(ifExpr: Expression, elseValue: unknown): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function ifAbsent(ifFieldName: string, elseExpr: Expression): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function ifAbsent(ifFieldName: string | Expression, elseValue: Expression | unknown): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function ifError(tryExpr: BooleanExpression, catchExpr: BooleanExpression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function ifError(tryExpr: Expression, catchExpr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function ifError(tryExpr: Expression, catchValue: unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function isAbsent(value: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function isAbsent(field: string): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function isError(value: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function join(arrayFieldName: string, delimiter: string): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function join(arrayExpression: Expression, delimiterExpression: Expression): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function join(arrayExpression: Expression, delimiter: string): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function join(arrayFieldName: string, delimiterExpression: Expression): Expression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function length_2(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function length_2(expression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function lessThan(left: Expression, right: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function lessThan(expression: Expression, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function lessThan(fieldName: string, expression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function lessThan(fieldName: string, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function lessThanOrEqual(left: Expression, right: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function lessThanOrEqual(expression: Expression, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function lessThanOrEqual(fieldName: string, expression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function lessThanOrEqual(fieldName: string, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function like(fieldName: string, pattern: string): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function like(fieldName: string, pattern: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function like(stringExpression: Expression, pattern: string): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function like(stringExpression: Expression, pattern: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function ln(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function ln(expression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function log10(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function log10(expression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function logicalMaximum(first: Expression, second: Expression | unknown, ...others: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function logicalMaximum(fieldName: string, second: Expression | unknown, ...others: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function logicalMinimum(first: Expression, second: Expression | unknown, ...others: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function logicalMinimum(fieldName: string, second: Expression | unknown, ...others: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function map(elements: Record): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function mapGet(fieldName: string, subField: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function mapGet(mapExpression: Expression, subField: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function mapMerge(mapField: string, secondMap: Record | Expression, ...otherMaps: Array | Expression>): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function mapMerge(firstMap: Record | Expression, secondMap: Record | Expression, ...otherMaps: Array | Expression>): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function mapRemove(mapField: string, key: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function mapRemove(mapExpr: Expression, key: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function mapRemove(mapField: string, keyExpr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function mapRemove(mapExpr: Expression, keyExpr: Expression): FunctionExpression; @@ -2645,155 +1607,63 @@ function mapRemove(mapExpr: Expression, keyExpr: Expression): FunctionExpression // @public export const MAX_REQUEST_RETRIES = 5; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function maximum(expression: Expression): AggregateFunction; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function maximum(fieldName: string): AggregateFunction; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function minimum(expression: Expression): AggregateFunction; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function minimum(fieldName: string): AggregateFunction; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function mod(left: Expression, right: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function mod(expression: Expression, value: unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function mod(fieldName: string, expression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function mod(fieldName: string, value: unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function multiply(first: Expression, second: Expression | unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function multiply(fieldName: string, second: Expression | unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function not(booleanExpr: BooleanExpression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function notEqual(left: Expression, right: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function notEqual(expression: Expression, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function notEqual(fieldName: string, expression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function notEqual(fieldName: string, value: unknown): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function notEqualAny(element: Expression, values: Array): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function notEqualAny(fieldName: string, values: Array): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function notEqualAny(element: Expression, arrayExpression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function notEqualAny(fieldName: string, arrayExpression: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function or(first: BooleanExpression, second: BooleanExpression, ...more: BooleanExpression[]): BooleanExpression; @@ -2822,100 +1692,40 @@ class Ordering implements HasUserData { class Pipeline implements firestore.Pipelines.Pipeline { // Warning: (ae-forgotten-export) The symbol "Stage" needs to be exported by the entry point index.d.ts constructor(db: Firestore, stages: Stage[]); - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@FunctionExpression" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration addFields(field: firestore.Pipelines.Selectable, ...additionalFields: firestore.Pipelines.Selectable[]): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@FunctionExpression" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration + // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag addFields(options: firestore.Pipelines.AddFieldsStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration aggregate(accumulator: firestore.Pipelines.AliasedAggregate, ...additionalAccumulators: firestore.Pipelines.AliasedAggregate[]): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration aggregate(options: firestore.Pipelines.AggregateStageOptions): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration distinct(group: string | firestore.Pipelines.Selectable, ...additionalGroups: Array): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration distinct(options: firestore.Pipelines.DistinctStageOptions): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration execute(pipelineExecuteOptions?: firestore.Pipelines.PipelineExecuteOptions): Promise; // Warning: (ae-forgotten-export) The symbol "PipelineResponse" needs to be exported by the entry point index.d.ts // // (undocumented) _execute(transactionOrReadTime?: Uint8Array | Timestamp | api.ITransactionOptions, pipelineExecuteOptions?: firestore.Pipelines.PipelineExecuteOptions): Promise; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration findNearest(options: firestore.Pipelines.FindNearestStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration limit(limit: number): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration limit(options: firestore.Pipelines.LimitStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration offset(offset: number): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration offset(options: firestore.Pipelines.OffsetStageOptions): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration rawStage(name: string, params: unknown[], options?: { [key: string]: Expression | unknown; }): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration removeFields(fieldValue: firestore.Pipelines.Field | string, ...additionalFields: Array): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration removeFields(options: firestore.Pipelines.RemoveFieldsStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration replaceWith(fieldName: string): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration replaceWith(expr: firestore.Pipelines.Expression): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration replaceWith(options: firestore.Pipelines.ReplaceWithStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration sample(documents: number): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration sample(options: firestore.Pipelines.SampleStageOptions): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration select(selection: firestore.Pipelines.Selectable | string, ...additionalSelections: Array): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration select(options: firestore.Pipelines.SelectStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration sort(ordering: firestore.Pipelines.Ordering, ...additionalOrderings: firestore.Pipelines.Ordering[]): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration sort(options: firestore.Pipelines.SortStageOptions): Pipeline; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2926,45 +1736,19 @@ class Pipeline implements firestore.Pipelines.Pipeline { // // (undocumented) _toStructuredPipeline(pipelineExecuteOptions?: firestore.Pipelines.PipelineExecuteOptions): StructuredPipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration union(other: firestore.Pipelines.Pipeline): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration union(options: firestore.Pipelines.UnionStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration unnest(selectable: firestore.Pipelines.Selectable, indexField?: string): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration unnest(options: firestore.Pipelines.UnnestStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration _validateUserData | HasUserData[] | HasUserData>(_: string, val: T): T; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration where(condition: firestore.Pipelines.BooleanExpression): Pipeline; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration where(options: firestore.Pipelines.WhereStageOptions): Pipeline; } // @beta class PipelineResult implements firestore.Pipelines.PipelineResult { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen constructor(serializer: Serializer, _fieldsProto: ApiMapValue, ref?: DocumentReference, readTime?: Timestamp, createTime?: Timestamp, updateTime?: Timestamp); // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag @@ -2982,7 +1766,6 @@ class PipelineResult implements firestore.Pipelines.PipelineResult { // // (undocumented) readonly _fieldsProto: ApiMapValue; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -2991,14 +1774,11 @@ class PipelineResult implements firestore.Pipelines.PipelineResult { // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" // Warning: (tsdoc-undefined-tag) The TSDoc tag "@type" is not defined in this configuration get id(): string | undefined; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: PipelineResult): boolean; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen protoField(field: string | FieldPath): api.IValue | undefined; get ref(): DocumentReference | undefined; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag @@ -3143,15 +1923,12 @@ class PipelineSource implements firestore.Pipelines.PipelineSource { collection(options: firestore.Pipelines.CollectionStageOptions): Pipeline; collectionGroup(collectionId: string): Pipeline; collectionGroup(options: firestore.Pipelines.CollectionGroupStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-undefined-tag) The TSDoc tag "@FirestoreError" is not defined in this configuration createFrom(query: firestore.VectorQuery): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-undefined-tag) The TSDoc tag "@FirestoreError" is not defined in this configuration createFrom(query: firestore.Query): Pipeline; database(): Pipeline; database(options: firestore.Pipelines.DatabaseStageOptions): Pipeline; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-undefined-tag) The TSDoc tag "@FirestoreError" is not defined in this configuration documents(docs: Array): Pipeline; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@FirestoreError" is not defined in this configuration @@ -3176,31 +1953,15 @@ export class PlanSummary implements firestore.PlanSummary { readonly indexesUsed: Record[]; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function pow(base: Expression, exponent: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function pow(base: Expression, exponent: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function pow(base: string, exponent: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// // @beta function pow(base: string, exponent: number): FunctionExpression; @@ -3209,14 +1970,11 @@ function pow(base: string, exponent: number): FunctionExpression; // @public export class Query implements firestore.Query { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal constructor( _firestore: Firestore, _queryOptions: QueryOptions); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen aggregate(aggregateSpec: T): AggregateQuery; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // @@ -3226,7 +1984,6 @@ export class Query, s2: QueryDocumentSnapshot) => number; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration count(): AggregateQuery<{ count: firestore.AggregateField; }, AppModelType, DbModelType>; @@ -3234,27 +1991,21 @@ export class Query Array>, changes: () => Array>): QuerySnapshot; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" endAt(...fieldValuesOrDocumentSnapshot: Array): Query; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" endBefore(...fieldValuesOrDocumentSnapshot: Array): Query; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration explain(options?: firestore.ExplainOptions): Promise>>; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" explainStream(explainOptions?: firestore.ExplainOptions): NodeJS.ReadableStream; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // Warning: (ae-forgotten-export) The symbol "FieldOrder" needs to be exported by the entry point index.d.ts // // @internal @@ -3280,7 +2031,6 @@ export class Query>; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal _get(transactionOrReadTime?: Uint8Array | Timestamp | api.ITransactionOptions): Promise>>; @@ -3291,39 +2041,29 @@ export class Query): boolean; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // // @internal _isPermanentRpcError(err: GoogleError, methodName: string): boolean; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" limit(limit: number): Query; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration limitToLast(limit: number): Query; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" offset(offset: number): Query; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" onSnapshot(onNext: (snapshot: QuerySnapshot) => void, onError?: (error: Error) => void): () => void; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -3358,7 +2098,6 @@ export class Query>; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -3367,12 +2106,10 @@ export class Query): Query; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -3380,8 +2117,6 @@ export class Query; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -3451,18 +2180,15 @@ export class QueryPartition; } @@ -3471,15 +2197,9 @@ export class QueryPartition implements firestore.QuerySnapshot { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen constructor(_query: Query, _readTime: Timestamp, _size: number, docs: () => Array>, changes: () => Array>); // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration docChanges(): Array>; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -3491,16 +2211,12 @@ export class QuerySnapshot) => void, thisArg?: unknown): void; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: firestore.QuerySnapshot): boolean; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -3519,361 +2235,156 @@ export class QuerySnapshot void) | null): void; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function split(fieldName: string, delimiter: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function split(fieldName: string, delimiter: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function split(expression: Expression, delimiter: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function split(expression: Expression, delimiter: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function sqrt(expression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function sqrt(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function startsWith(fieldName: string, prefix: string): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function startsWith(fieldName: string, prefix: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function startsWith(stringExpression: Expression, prefix: string): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function startsWith(stringExpression: Expression, prefix: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function stringConcat(fieldName: string, secondString: Expression | string, ...otherStrings: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function stringConcat(firstString: Expression, secondString: Expression | string, ...otherStrings: Array): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function stringContains(fieldName: string, substring: string): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function stringContains(fieldName: string, substring: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function stringContains(stringExpression: Expression, substring: string): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function stringContains(stringExpression: Expression, substring: Expression): BooleanExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function stringReverse(stringExpression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function stringReverse(field: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function substring(field: string, position: number, length?: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function substring(input: Expression, position: number, length?: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function substring(field: string, position: Expression, length?: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// // @beta function substring(input: Expression, position: Expression, length?: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function subtract(minuend: Expression, subtrahend: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function subtract(minuend: Expression, subtrahend: unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function subtract(minuendFieldName: string, subtrahend: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function subtract(minuendFieldName: string, subtrahend: unknown): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function sum(expression: Expression): AggregateFunction; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function sum(fieldName: string): AggregateFunction; // @public export class Timestamp implements firestore.Timestamp { - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' constructor(seconds: number, nanoseconds: number); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration static fromDate(date: Date): Timestamp; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration static fromMillis(milliseconds: number): Timestamp; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // // @internal static fromProto(timestamp: google.protobuf.ITimestamp): Timestamp; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: firestore.Timestamp): boolean; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -3881,7 +2392,6 @@ export class Timestamp implements firestore.Timestamp { get nanoseconds(): number; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration static now(): Timestamp; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -3889,11 +2399,9 @@ export class Timestamp implements firestore.Timestamp { get seconds(): number; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration toDate(): Date; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration toMillis(): number; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag @@ -3903,112 +2411,47 @@ export class Timestamp implements firestore.Timestamp { toProto(): api.IValue; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration valueOf(): string; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampAdd(timestamp: Expression, unit: Expression, amount: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampAdd(timestamp: Expression, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day', amount: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampAdd(fieldName: string, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day', amount: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampSubtract(timestamp: Expression, unit: Expression, amount: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampSubtract(timestamp: Expression, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day', amount: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampSubtract(fieldName: string, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day', amount: number): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampToUnixMicros(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampToUnixMicros(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampToUnixMillis(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampToUnixMillis(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampToUnixSeconds(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function timestampToUnixSeconds(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "Expression" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "FunctionExpression" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "Expression" which is marked as @beta @@ -4017,12 +2460,8 @@ function timestampToUnixSeconds(fieldName: string): FunctionExpression; // @public function timestampTruncate(fieldName: string, granularity: firestore.Pipelines.TimeGranularity, timezone?: string | Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "Expression" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "FunctionExpression" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "Expression" which is marked as @beta @@ -4031,12 +2470,8 @@ function timestampTruncate(fieldName: string, granularity: firestore.Pipelines.T // @public function timestampTruncate(fieldName: string, granularity: Expression, timezone?: string | Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "Expression" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "FunctionExpression" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "Expression" which is marked as @beta @@ -4045,12 +2480,8 @@ function timestampTruncate(fieldName: string, granularity: Expression, timezone? // @public function timestampTruncate(timestampExpression: Expression, granularity: firestore.Pipelines.TimeGranularity, timezone?: string | Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "Expression" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "FunctionExpression" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "timestampTruncate" is marked as @public, but its signature references "Expression" which is marked as @beta @@ -4059,31 +2490,15 @@ function timestampTruncate(timestampExpression: Expression, granularity: firesto // @public function timestampTruncate(timestampExpression: Expression, granularity: Expression, timezone?: string | Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function toLower(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function toLower(stringExpression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function toUpper(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function toUpper(stringExpression: Expression): FunctionExpression; @@ -4092,24 +2507,17 @@ function toUpper(stringExpression: Expression): FunctionExpression; // @public export class Transaction implements firestore.Transaction { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen constructor(firestore: Firestore, requestTag: string, transactionOptions?: firestore.ReadWriteTransactionOptions | firestore.ReadOnlyTransactionOptions); // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // // @internal commit(): Promise; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" create(documentRef: firestore.DocumentReference, data: firestore.WithFieldValue): Transaction; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -4122,26 +2530,18 @@ export class Transaction implements firestore.Transaction { // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" delete(documentRef: DocumentReference, precondition?: firestore.Precondition): this; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // Warning: (ae-incompatible-release-tags) The symbol "execute" is marked as @public, but its signature references "Pipeline" which is marked as @beta // Warning: (ae-incompatible-release-tags) The symbol "execute" is marked as @public, but its signature references "PipelineSnapshot" which is marked as @beta execute(pipeline: Pipeline): Promise; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration get(query: firestore.Query): Promise>; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration get(documentRef: firestore.DocumentReference): Promise>; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration get(aggregateQuery: firestore.AggregateQuery): Promise>; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -4151,12 +2551,10 @@ export class Transaction implements firestore.Transaction { // @internal rollback(): Promise; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal runTransaction(updateFunction: (transaction: Transaction) => Promise): Promise; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // // @internal runTransactionOnce(updateFunction: (transaction: Transaction) => Promise): Promise; @@ -4164,9 +2562,7 @@ export class Transaction implements firestore.Transaction { set(documentRef: firestore.DocumentReference, data: firestore.PartialWithFieldValue, options: firestore.SetOptions): Transaction; // (undocumented) set(documentRef: firestore.DocumentReference, data: firestore.WithFieldValue): Transaction; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag @@ -4176,89 +2572,45 @@ export class Transaction implements firestore.Transaction { update(documentRef: firestore.DocumentReference, dataOrField: firestore.UpdateData | string | firestore.FieldPath, ...preconditionOrValues: Array): Transaction; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function trim(fieldName: string, valueToTrim?: string | Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function trim(stringExpression: Expression, valueToTrim?: string | Expression): FunctionExpression; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // // @beta function type(fieldName: string): FunctionExpression; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // // @beta function type(expression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function unixMicrosToTimestamp(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function unixMicrosToTimestamp(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function unixMillisToTimestamp(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function unixMillisToTimestamp(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function unixSecondsToTimestamp(expr: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function unixSecondsToTimestamp(fieldName: string): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function vectorLength(vectorExpression: Expression): FunctionExpression; -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function vectorLength(fieldName: string): FunctionExpression; @@ -4272,7 +2624,6 @@ export class VectorQuery Array>, changes: () => Array>): VectorQuerySnapshot; - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration explain(options?: firestore.ExplainOptions): Promise>>; get(): Promise>; // (undocumented) @@ -4357,7 +2708,6 @@ export class WriteBatch implements firestore.WriteBatch { // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" commit(): Promise; // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters // @@ -4368,18 +2718,14 @@ export class WriteBatch implements firestore.WriteBatch { retryCodes?: number[]; methodName?: FirestoreUnaryMethod; }): Promise; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" create(documentRef: firestore.DocumentReference, data: firestore.WithFieldValue): WriteBatch; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -4410,9 +2756,7 @@ export class WriteBatch implements firestore.WriteBatch { set(documentRef: firestore.DocumentReference, data: firestore.PartialWithFieldValue, options: firestore.SetOptions): WriteBatch; // (undocumented) set(documentRef: firestore.DocumentReference, data: firestore.WithFieldValue): WriteBatch; - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag @@ -4429,11 +2773,8 @@ export class WriteBatch implements firestore.WriteBatch { // @public export class WriteResult implements firestore.WriteResult { // Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen constructor(_writeTime: Timestamp); - // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' - // Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration isEqual(other: firestore.WriteResult): boolean; // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" @@ -4442,19 +2783,11 @@ export class WriteResult implements firestore.WriteResult { get writeTime(): Timestamp; } -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@code" is not defined in this configuration -// // @beta function xor(first: BooleanExpression, second: BooleanExpression, ...additionalConditions: BooleanExpression[]): BooleanExpression; // Warnings were encountered during analysis: // -// build/types/src/aggregate.d.ts:48:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// build/types/src/aggregate.d.ts:49:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/bulk-writer.d.ts:49:4 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/bulk-writer.d.ts:83:4 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/bulk-writer.d.ts:146:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration @@ -4467,7 +2800,6 @@ function xor(first: BooleanExpression, second: BooleanExpression, ...additionalC // build/types/src/bulk-writer.d.ts:217:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/bulk-writer.d.ts:229:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/bulk-writer.d.ts:236:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// build/types/src/bulk-writer.d.ts:487:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/bulk-writer.d.ts:490:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/bulk-writer.d.ts:496:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/bulk-writer.d.ts:503:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration @@ -4487,14 +2819,7 @@ function xor(first: BooleanExpression, second: BooleanExpression, ...additionalC // build/types/src/index.d.ts:387:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/index.d.ts:881:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/index.d.ts:900:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// build/types/src/index.d.ts:902:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// build/types/src/index.d.ts:904:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// build/types/src/index.d.ts:905:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/index.d.ts:915:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// build/types/src/index.d.ts:917:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// build/types/src/index.d.ts:918:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// build/types/src/index.d.ts:920:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// build/types/src/index.d.ts:921:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/path.d.ts:29:4 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/path.d.ts:31:4 - (tsdoc-undefined-tag) The TSDoc tag "@class" is not defined in this configuration // build/types/src/path.d.ts:146:4 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration @@ -4506,21 +2831,13 @@ function xor(first: BooleanExpression, second: BooleanExpression, ...additionalC // build/types/src/reference/field-order.d.ts:22:4 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/reference/field-order.d.ts:24:4 - (tsdoc-undefined-tag) The TSDoc tag "@class" is not defined in this configuration // build/types/src/reference/query-options.d.ts:27:4 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// build/types/src/reference/query.d.ts:435:8 - (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // build/types/src/reference/query.d.ts:441:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// build/types/src/reference/query.d.ts:443:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/reference/query.d.ts:452:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// build/types/src/reference/query.d.ts:454:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/reference/query.d.ts:454:15 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' -// build/types/src/reference/query.d.ts:456:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/reference/query.d.ts:456:15 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}' -// build/types/src/reference/query.d.ts:458:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/reference/query.d.ts:460:24 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // build/types/src/reference/query.d.ts:460:17 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" -// build/types/src/reference/query.d.ts:469:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen -// build/types/src/reference/query.d.ts:471:8 - (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration // build/types/src/reference/query.d.ts:473:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration -// build/types/src/reference/query.d.ts:659:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // build/types/src/reference/query.d.ts:660:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/reference/vector-query.d.ts:51:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration // build/types/src/reference/vector-query.d.ts:56:8 - (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration diff --git a/dev/src/aggregate.ts b/dev/src/aggregate.ts index 0d433a994..c0fe62dca 100644 --- a/dev/src/aggregate.ts +++ b/dev/src/aggregate.ts @@ -101,7 +101,7 @@ export class AggregateField implements firestore.AggregateField { * `other` performs the same kind of aggregation on the same field (if any). * * @param other The object to compare to this object for equality. - * @return `true` if this object is "equal" to the given object, as + * @returns `true` if this object is "equal" to the given object, as * defined above, or `false` otherwise. */ isEqual(other: AggregateField): boolean { diff --git a/dev/src/backoff.ts b/dev/src/backoff.ts index 97ddb0801..e672d75d6 100644 --- a/dev/src/backoff.ts +++ b/dev/src/backoff.ts @@ -248,7 +248,7 @@ export class ExponentialBackoff { * Returns a promise that resolves after currentDelayMs, and increases the * delay for any subsequent attempts. * - * @return A Promise that resolves when the current delay elapsed. + * @returns A Promise that resolves when the current delay elapsed. * @private * @internal */ diff --git a/dev/src/bulk-writer.ts b/dev/src/bulk-writer.ts index ccc84c565..251baefb4 100644 --- a/dev/src/bulk-writer.ts +++ b/dev/src/bulk-writer.ts @@ -865,7 +865,7 @@ export class BulkWriter { * for writes that were added after the method is called. If you want to wait * for additional writes, call `flush()` again. * - * @return {Promise} A promise that resolves when all enqueued writes + * @returns {Promise} A promise that resolves when all enqueued writes * up to this point have been committed. * * @example @@ -906,7 +906,7 @@ export class BulkWriter { * Promise will never be rejected. Calling this method will send all requests. * The promise resolves immediately if there are no pending writes. * - * @return {Promise} A promise that resolves when all enqueued writes + * @returns {Promise} A promise that resolves when all enqueued writes * up to this point have been committed. * * @example diff --git a/dev/src/collection-group.ts b/dev/src/collection-group.ts index cb63f7af9..cd58e0634 100644 --- a/dev/src/collection-group.ts +++ b/dev/src/collection-group.ts @@ -76,7 +76,7 @@ export class CollectionGroup< * @param {number} desiredPartitionCount The desired maximum number of * partition points. The number must be strictly positive. The actual number * of partitions returned may be fewer. - * @return {AsyncIterable} An AsyncIterable of + * @returns {AsyncIterable} An AsyncIterable of * `QueryPartition`s. */ async *getPartitions( @@ -198,7 +198,7 @@ export class CollectionGroup< * ``` * @param {FirestoreDataConverter | null} converter Converts objects to and * from Firestore. Passing in `null` removes the current converter. - * @return {CollectionGroup} A `CollectionGroup` that uses the provided + * @returns {CollectionGroup} A `CollectionGroup` that uses the provided * converter. */ withConverter< diff --git a/dev/src/convert.ts b/dev/src/convert.ts index 8b6585da1..c44e08401 100644 --- a/dev/src/convert.ts +++ b/dev/src/convert.ts @@ -43,7 +43,7 @@ import {RESERVED_MAP_KEY, RESERVED_MAP_KEY_VECTOR_VALUE} from './map-type'; * @param timestampValue The value to convert. * @param argumentName The argument name to use in the error message if the * conversion fails. If omitted, 'timestampValue' is used. - * @return The value as expected by Protobuf JS or undefined if no input was + * @returns The value as expected by Protobuf JS or undefined if no input was * provided. */ export function timestampFromJson( @@ -94,7 +94,7 @@ export function timestampFromJson( * @private * @internal * @param bytesValue The value to convert. - * @return The value as expected by Protobuf JS. + * @returns The value as expected by Protobuf JS. */ function bytesFromJson(bytesValue: string | Uint8Array): Uint8Array { if (typeof bytesValue === 'string') { @@ -110,7 +110,7 @@ function bytesFromJson(bytesValue: string | Uint8Array): Uint8Array { * @private * @internal * @param proto The `firestore.v1.Value` proto. - * @return The string value for 'valueType'. + * @returns The string value for 'valueType'. */ export function detectValueType(proto: ProtobufJsValue): string { let valueType: string | undefined; @@ -187,7 +187,7 @@ export function detectValueType(proto: ProtobufJsValue): string { * @private * @internal * @param proto The `firestore.v1.Value` proto. - * @return The string value for 'valueType'. + * @returns The string value for 'valueType'. */ export function detectGoogleProtobufValueType( proto: google.protobuf.IValue, @@ -229,7 +229,7 @@ export function detectGoogleProtobufValueType( * @private * @internal * @param fieldValue The `firestore.v1.Value` in Proto3 JSON format. - * @return The `firestore.v1.Value` in Protobuf JS format. + * @returns The `firestore.v1.Value` in Protobuf JS format. */ export function valueFromJson(fieldValue: api.IValue): api.IValue { const valueType = detectValueType(fieldValue); @@ -288,7 +288,7 @@ export function valueFromJson(fieldValue: api.IValue): api.IValue { * @private * @internal * @param document An object with IValues in Proto3 JSON format. - * @return The object in Protobuf JS format. + * @returns The object in Protobuf JS format. */ export function fieldsFromJson(document: ApiMapValue): ApiMapValue { const result: ApiMapValue = {}; diff --git a/dev/src/document-change.ts b/dev/src/document-change.ts index fe29238b7..ea1e3cc69 100644 --- a/dev/src/document-change.ts +++ b/dev/src/document-change.ts @@ -181,7 +181,7 @@ export class DocumentChange< * value. * * @param {*} other The value to compare against. - * @return true if this `DocumentChange` is equal to the provided value. + * @returns true if this `DocumentChange` is equal to the provided value. */ isEqual(other: firestore.DocumentChange): boolean { if (this === other) { diff --git a/dev/src/document.ts b/dev/src/document.ts index fad621214..9c809c52b 100644 --- a/dev/src/document.ts +++ b/dev/src/document.ts @@ -158,7 +158,7 @@ export class DocumentSnapshot< * @internal * @param ref The reference to the document. * @param obj The object to store in the DocumentSnapshot. - * @return The created DocumentSnapshot. + * @returns The created DocumentSnapshot. */ static fromObject( ref: DocumentReference, @@ -177,7 +177,7 @@ export class DocumentSnapshot< * @internal * @param ref The reference to the document. * @param data The field/value map to expand. - * @return The created DocumentSnapshot. + * @returns The created DocumentSnapshot. */ static fromUpdateMap< AppModelType, @@ -552,7 +552,7 @@ export class DocumentSnapshot< * equal to the provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `DocumentSnapshot` is equal to the provided + * @returns {boolean} true if this `DocumentSnapshot` is equal to the provided * value. */ isEqual( @@ -783,7 +783,7 @@ export class DocumentMask { * * @private * @internal - * @return {boolean} Whether this document mask is empty. + * @returns {boolean} Whether this document mask is empty. */ get isEmpty(): boolean { return this._sortedPaths.length === 0; @@ -835,7 +835,7 @@ export class DocumentMask { * @private * @internal * @param fieldPath The field path to test. - * @return Whether this document mask contains 'fieldPath'. + * @returns Whether this document mask contains 'fieldPath'. */ contains(fieldPath: FieldPath): boolean { for (const sortedPath of this._sortedPaths) { @@ -858,7 +858,7 @@ export class DocumentMask { * @private * @internal * @param data An object to filter. - * @return A shallow copy of the object filtered by this document mask. + * @returns A shallow copy of the object filtered by this document mask. */ applyTo(data: firestore.DocumentData): firestore.DocumentData { /*! diff --git a/dev/src/field-value.ts b/dev/src/field-value.ts index 271b409c1..46d4a9794 100644 --- a/dev/src/field-value.ts +++ b/dev/src/field-value.ts @@ -130,7 +130,7 @@ export class FieldValue implements firestore.FieldValue { * Returns a sentinel used with set(), create() or update() to include a * server-generated timestamp in the written data. * - * @return {FieldValue} The FieldValue sentinel for use in a call to set(), + * @returns {FieldValue} The FieldValue sentinel for use in a call to set(), * create() or update(). * * @example @@ -164,7 +164,7 @@ export class FieldValue implements firestore.FieldValue { * not yet exist, the transformation will set the field to the given value. * * @param {number} n The value to increment by. - * @return {FieldValue} The FieldValue sentinel for use in a call to set(), + * @returns {FieldValue} The FieldValue sentinel for use in a call to set(), * create() or update(). * * @example @@ -195,7 +195,7 @@ export class FieldValue implements firestore.FieldValue { * exactly the specified elements. * * @param {...*} elements The elements to union into the array. - * @return {FieldValue} The FieldValue sentinel for use in a call to set(), + * @returns {FieldValue} The FieldValue sentinel for use in a call to set(), * create() or update(). * * @example @@ -224,7 +224,7 @@ export class FieldValue implements firestore.FieldValue { * an array it will be overwritten with an empty array. * * @param {...*} elements The elements to remove from the array. - * @return {FieldValue} The FieldValue sentinel for use in a call to set(), + * @returns {FieldValue} The FieldValue sentinel for use in a call to set(), * create() or update(). * * @example @@ -249,7 +249,7 @@ export class FieldValue implements firestore.FieldValue { * Returns true if this `FieldValue` is equal to the provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `FieldValue` is equal to the provided value. + * @returns {boolean} true if this `FieldValue` is equal to the provided value. * * @example * ``` @@ -316,7 +316,7 @@ export abstract class FieldTransform extends FieldValue { * * @param serializer The Firestore serializer. * @param fieldPath The field path to apply this transformation to. - * @return The 'FieldTransform' proto message. + * @returns The 'FieldTransform' proto message. */ abstract toProto( serializer: Serializer, diff --git a/dev/src/geo-point.ts b/dev/src/geo-point.ts index 5727179ed..0c9ecab13 100644 --- a/dev/src/geo-point.ts +++ b/dev/src/geo-point.ts @@ -84,7 +84,7 @@ export class GeoPoint implements Serializable, firestore.GeoPoint { * Returns true if this `GeoPoint` is equal to the provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `GeoPoint` is equal to the provided value. + * @returns {boolean} true if this `GeoPoint` is equal to the provided value. */ isEqual(other: firestore.GeoPoint): boolean { return ( diff --git a/dev/src/index.ts b/dev/src/index.ts index 25aad86c2..d5a74afd5 100644 --- a/dev/src/index.ts +++ b/dev/src/index.ts @@ -950,7 +950,7 @@ export class Firestore implements firestore.Firestore { /** * @beta - * Creates and returns a new PipelineSource, which allows specifying the source stage of a {@link Pipeline}. + * Creates and returns a new PipelineSource, which allows specifying the source stage of a `Pipeline`. * * @example * ``` @@ -991,7 +991,7 @@ export class Firestore implements firestore.Firestore { * multiple writes in parallel. Gradually ramps up writes as specified * by the 500/50/5 rule. * - * If you pass [BulkWriterOptions]{@link BulkWriterOptions}, you can + * If you pass `BulkWriterOptions`, you can * configure the throttling rates for the created BulkWriter. * * @see [500/50/5 Documentation]{@link https://firebase.google.com/docs/firestore/best-practices#ramping_up_traffic} @@ -1436,7 +1436,7 @@ export class Firestore implements firestore.Firestore { * @param ref The reference of a document or collection to delete. * @param bulkWriter A custom BulkWriter instance used to perform the * deletes. - * @return A promise that resolves when all deletes have been performed. + * @returns A promise that resolves when all deletes have been performed. * The promise is rejected if any of the deletes fail. * * @example @@ -1502,7 +1502,7 @@ export class Firestore implements firestore.Firestore { /** * Terminates the Firestore client and closes all open streams. * - * @return A Promise that resolves when the client is terminated. + * @returns A Promise that resolves when the client is terminated. */ async terminate(): Promise { if (this._bulkWriter) { @@ -1524,7 +1524,7 @@ export class Firestore implements firestore.Firestore { * Returns the Project ID to serve as the JSON representation of this * Firestore instance. * - * @return An object that contains the project ID (or `undefined` if not yet + * @returns An object that contains the project ID (or `undefined` if not yet * available). */ toJSON(): object { @@ -1538,7 +1538,7 @@ export class Firestore implements firestore.Firestore { * @internal * @param requestTag A unique client-assigned identifier that caused this * initialization. - * @return A Promise that resolves when the client is initialized. + * @returns A Promise that resolves when the client is initialized. */ async initializeIfNeeded(requestTag: string): Promise { this._settingsFrozen = true; diff --git a/dev/src/path.ts b/dev/src/path.ts index 0b250b161..05446275e 100644 --- a/dev/src/path.ts +++ b/dev/src/path.ts @@ -282,7 +282,7 @@ abstract class Path { * @private * @internal * @param other The value to compare against. - * @return true if this `Path` is equal to the provided value. + * @returns true if this `Path` is equal to the provided value. */ isEqual(other: Path): boolean { return this === other || this.compareTo(other) === 0; @@ -387,7 +387,7 @@ export class ResourcePath extends Path { * @private * @internal * @param projectId The project ID of the current Firestore project. - * @return A fully-qualified resource path pointing to the same element. + * @returns A fully-qualified resource path pointing to the same element. */ toQualifiedResourcePath( projectId: string, @@ -774,7 +774,7 @@ export class FieldPath extends Path implements firestore.FieldPath { * Returns true if this `FieldPath` is equal to the provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `FieldPath` is equal to the provided value. + * @returns {boolean} true if this `FieldPath` is equal to the provided value. */ isEqual(other: FieldPath): boolean { return super.isEqual(other); diff --git a/dev/src/pipelines/expression.ts b/dev/src/pipelines/expression.ts index fec0d9501..c43b9e43d 100644 --- a/dev/src/pipelines/expression.ts +++ b/dev/src/pipelines/expression.ts @@ -31,8 +31,7 @@ import {cast} from '../util'; /** * @beta - * Represents an expression that can be evaluated to a value within the execution of a {@link - * Pipeline}. + * Represents an expression that can be evaluated to a value within the execution of a `Pipeline`. * * Expressions are the building blocks for creating complex queries and transformations in * Firestore pipelines. They can represent: @@ -77,6 +76,7 @@ export abstract class Expression * @beta * Creates an expression that adds this expression to another expression. * + * @example * ```typescript * // Add the value of the 'quantity' field and the 'reserve' field. * field("quantity").add(field("reserve")); @@ -84,7 +84,7 @@ export abstract class Expression * * @param second The expression or literal to add to this expression. * @param others Optional additional expressions or literals to add to this expression. - * @return A new `Expression` representing the addition operation. + * @returns A new `Expression` representing the addition operation. */ add( second: firestore.Pipelines.Expression | unknown, @@ -101,7 +101,7 @@ export abstract class Expression * @beta * Wraps the expression in a [BooleanExpression]. * - * @return A [BooleanExpression] representing the same expression. + * @returns A `BooleanExpression` representing the same expression. */ asBoolean(): BooleanExpression { if (this instanceof BooleanExpression) { @@ -123,13 +123,14 @@ export abstract class Expression * @beta * Creates an expression that subtracts another expression from this expression. * + * @example * ```typescript * // Subtract the 'discount' field from the 'price' field * field("price").subtract(field("discount")); * ``` * * @param subtrahend The expression to subtract from this expression. - * @return A new `Expression` representing the subtraction operation. + * @returns A new `Expression` representing the subtraction operation. */ subtract(subtrahend: firestore.Pipelines.Expression): FunctionExpression; @@ -137,13 +138,14 @@ export abstract class Expression * @beta * Creates an expression that subtracts a constant value from this expression. * + * @example * ```typescript * // Subtract 20 from the value of the 'total' field * field("total").subtract(20); * ``` * * @param subtrahend The constant value to subtract. - * @return A new `Expression` representing the subtraction operation. + * @returns A new `Expression` representing the subtraction operation. */ subtract(subtrahend: number): FunctionExpression; subtract( @@ -159,6 +161,7 @@ export abstract class Expression * @beta * Creates an expression that multiplies this expression by another expression. * + * @example * ```typescript * // Multiply the 'quantity' field by the 'price' field * field("quantity").multiply(field("price")); @@ -166,7 +169,7 @@ export abstract class Expression * * @param second The second expression or literal to multiply by. * @param others Optional additional expressions or literals to multiply by. - * @return A new `Expression` representing the multiplication operation. + * @returns A new `Expression` representing the multiplication operation. */ multiply( second: Expression | number, @@ -183,13 +186,14 @@ export abstract class Expression * @beta * Creates an expression that divides this expression by another expression. * + * @example * ```typescript * // Divide the 'total' field by the 'count' field * field("total").divide(field("count")); * ``` * * @param divisor The expression to divide by. - * @return A new `Expression` representing the division operation. + * @returns A new `Expression` representing the division operation. */ divide(divisor: Expression): FunctionExpression; @@ -197,13 +201,14 @@ export abstract class Expression * @beta * Creates an expression that divides this expression by a constant value. * + * @example * ```typescript * // Divide the 'value' field by 10 * field("value").divide(10); * ``` * * @param divisor The constant value to divide by. - * @return A new `Expression` representing the division operation. + * @returns A new `Expression` representing the division operation. */ divide(divisor: number): FunctionExpression; divide(divisor: number | Expression): FunctionExpression { @@ -217,13 +222,14 @@ export abstract class Expression * @beta * Creates an expression that calculates the modulo (remainder) of dividing this expression by another expression. * + * @example * ```typescript * // Calculate the remainder of dividing the 'value' field by the 'divisor' field * field("value").mod(field("divisor")); * ``` * * @param expression The expression to divide by. - * @return A new `Expression` representing the modulo operation. + * @returns A new `Expression` representing the modulo operation. */ mod(expression: Expression): FunctionExpression; @@ -231,13 +237,14 @@ export abstract class Expression * @beta * Creates an expression that calculates the modulo (remainder) of dividing this expression by a constant value. * + * @example * ```typescript * // Calculate the remainder of dividing the 'value' field by 10 * field("value").mod(10); * ``` * * @param value The constant value to divide by. - * @return A new `Expression` representing the modulo operation. + * @returns A new `Expression` representing the modulo operation. */ mod(value: number): FunctionExpression; mod(other: number | Expression): FunctionExpression { @@ -248,13 +255,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is equal to another expression. * + * @example * ```typescript * // Check if the 'age' field is equal to 21 * field("age").equal(21); * ``` * * @param expression The expression to compare for equality. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ equal(expression: Expression): BooleanExpression; @@ -262,13 +270,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is equal to a constant value. * + * @example * ```typescript * // Check if the 'city' field is equal to "London" * field("city").equal("London"); * ``` * * @param value The constant value to compare for equality. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ equal(value: unknown): BooleanExpression; equal(other: unknown): BooleanExpression { @@ -282,13 +291,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is not equal to another expression. * + * @example * ```typescript * // Check if the 'status' field is not equal to "completed" * field("status").notEqual("completed"); * ``` * * @param expression The expression to compare for inequality. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ notEqual(expression: Expression): BooleanExpression; @@ -296,13 +306,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is not equal to a constant value. * + * @example * ```typescript * // Check if the 'country' field is not equal to "USA" * field("country").notEqual("USA"); * ``` * * @param value The constant value to compare for inequality. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ notEqual(value: unknown): BooleanExpression; notEqual(other: unknown): BooleanExpression { @@ -316,13 +327,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is less than another expression. * + * @example * ```typescript * // Check if the 'age' field is less than 'limit' * field("age").lessThan(field('limit')); * ``` * * @param experession The expression to compare for less than. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ lessThan(experession: Expression): BooleanExpression; @@ -330,13 +342,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is less than a constant value. * + * @example * ```typescript * // Check if the 'price' field is less than 50 * field("price").lessThan(50); * ``` * * @param value The constant value to compare for less than. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ lessThan(value: unknown): BooleanExpression; lessThan(other: unknown): BooleanExpression { @@ -351,13 +364,14 @@ export abstract class Expression * Creates an expression that checks if this expression is less than or equal to another * expression. * + * @example * ```typescript * // Check if the 'quantity' field is less than or equal to 20 * field("quantity").lessThanOrEqual(constant(20)); * ``` * * @param expression The expression to compare for less than or equal to. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ lessThanOrEqual(expression: Expression): BooleanExpression; @@ -365,13 +379,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is less than or equal to a constant value. * + * @example * ```typescript * // Check if the 'score' field is less than or equal to 70 * field("score").lessThanOrEqual(70); * ``` * * @param value The constant value to compare for less than or equal to. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ lessThanOrEqual(value: unknown): BooleanExpression; lessThanOrEqual(other: unknown): BooleanExpression { @@ -385,13 +400,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is greater than another expression. * + * @example * ```typescript * // Check if the 'age' field is greater than the 'limit' field * field("age").greaterThan(field("limit")); * ``` * * @param expression The expression to compare for greater than. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ greaterThan(expression: Expression): BooleanExpression; @@ -399,13 +415,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is greater than a constant value. * + * @example * ```typescript * // Check if the 'price' field is greater than 100 * field("price").greaterThan(100); * ``` * * @param value The constant value to compare for greater than. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ greaterThan(value: unknown): BooleanExpression; greaterThan(other: unknown): BooleanExpression { @@ -420,13 +437,14 @@ export abstract class Expression * Creates an expression that checks if this expression is greater than or equal to another * expression. * + * @example * ```typescript * // Check if the 'quantity' field is greater than or equal to field 'requirement' plus 1 * field("quantity").greaterThanOrEqual(field('requirement').add(1)); * ``` * * @param expression The expression to compare for greater than or equal to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ greaterThanOrEqual(expression: Expression): BooleanExpression; @@ -435,13 +453,14 @@ export abstract class Expression * Creates an expression that checks if this expression is greater than or equal to a constant * value. * + * @example * ```typescript * // Check if the 'score' field is greater than or equal to 80 * field("score").greaterThanOrEqual(80); * ``` * * @param value The constant value to compare for greater than or equal to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ greaterThanOrEqual(value: unknown): BooleanExpression; greaterThanOrEqual(other: unknown): BooleanExpression { @@ -455,13 +474,14 @@ export abstract class Expression * @beta * Creates an expression that concatenates an array expression with one or more other arrays. * + * @example * ```typescript * // Combine the 'items' array with another array field. * field("items").arrayConcat(field("otherItems")); * ``` * @param secondArray Second array expression or array literal to concatenate. * @param otherArrays Optional additional array expressions or array literals to concatenate. - * @return A new `Expr` representing the concatenated array. + * @returns A new `Expr` representing the concatenated array. */ arrayConcat( secondArray: Expression | unknown[], @@ -476,13 +496,14 @@ export abstract class Expression * @beta * Creates an expression that checks if an array contains a specific element. * + * @example * ```typescript * // Check if the 'sizes' array contains the value from the 'selectedSize' field * field("sizes").arrayContains(field("selectedSize")); * ``` * * @param expression The element to search for in the array. - * @return A new `Expression` representing the 'array_contains' comparison. + * @returns A new `Expression` representing the 'array_contains' comparison. */ arrayContains(expression: Expression): BooleanExpression; @@ -490,13 +511,14 @@ export abstract class Expression * @beta * Creates an expression that checks if an array contains a specific value. * + * @example * ```typescript * // Check if the 'colors' array contains "red" * field("colors").arrayContains("red"); * ``` * * @param value The element to search for in the array. - * @return A new `Expression` representing the 'array_contains' comparison. + * @returns A new `Expression` representing the 'array_contains' comparison. */ arrayContains(value: unknown): BooleanExpression; arrayContains(element: unknown): BooleanExpression { @@ -510,13 +532,14 @@ export abstract class Expression * @beta * Creates an expression that checks if an array contains all the specified elements. * + * @example * ```typescript * // Check if the 'tags' array contains both the value in field "tag1" and the literal value "tag2" * field("tags").arrayContainsAll([field("tag1"), "tag2"]); * ``` * * @param values The elements to check for in the array. - * @return A new `Expression` representing the 'array_contains_all' comparison. + * @returns A new `Expression` representing the 'array_contains_all' comparison. */ arrayContainsAll(values: Array): BooleanExpression; @@ -524,13 +547,14 @@ export abstract class Expression * @beta * Creates an expression that checks if an array contains all the specified elements. * + * @example * ```typescript * // Check if the 'tags' array contains both of the values from field "tag1" and the literal value "tag2" * field("tags").arrayContainsAll(array([field("tag1"), "tag2"])); * ``` * * @param arrayExpression The elements to check for in the array. - * @return A new `Expression` representing the 'array_contains_all' comparison. + * @returns A new `Expression` representing the 'array_contains_all' comparison. */ arrayContainsAll(arrayExpression: Expression): BooleanExpression; arrayContainsAll(values: unknown[] | Expression): BooleanExpression { @@ -547,13 +571,14 @@ export abstract class Expression * @beta * Creates an expression that checks if an array contains any of the specified elements. * + * @example * ```typescript * // Check if the 'categories' array contains either values from field "cate1" or "cate2" * field("categories").arrayContainsAny([field("cate1"), field("cate2")]); * ``` * * @param values The elements to check for in the array. - * @return A new `Expression` representing the 'array_contains_any' comparison. + * @returns A new `Expression` representing the 'array_contains_any' comparison. */ arrayContainsAny(values: Array): BooleanExpression; @@ -561,6 +586,7 @@ export abstract class Expression * @beta * Creates an expression that checks if an array contains any of the specified elements. * + * @example * ```typescript * // Check if the 'groups' array contains either the value from the 'userGroup' field * // or the value "guest" @@ -568,7 +594,7 @@ export abstract class Expression * ``` * * @param arrayExpression The elements to check for in the array. - * @return A new `Expression` representing the 'array_contains_any' comparison. + * @returns A new `Expression` representing the 'array_contains_any' comparison. */ arrayContainsAny(arrayExpression: Expression): BooleanExpression; arrayContainsAny( @@ -587,12 +613,13 @@ export abstract class Expression * @beta * Creates an expression that reverses an array. * + * @example * ```typescript * // Reverse the value of the 'myArray' field. * field("myArray").arrayReverse(); * ``` * - * @return A new {@code Expression} representing the reversed array. + * @returns A new `Expression` representing the reversed array. */ arrayReverse(): FunctionExpression { return new FunctionExpression('array_reverse', [this]); @@ -602,12 +629,13 @@ export abstract class Expression * @beta * Creates an expression that calculates the length of an array. * + * @example * ```typescript * // Get the number of items in the 'cart' array * field("cart").arrayLength(); * ``` * - * @return A new `Expression` representing the length of the array. + * @returns A new `Expression` representing the length of the array. */ arrayLength(): FunctionExpression { return new FunctionExpression('array_length', [this]); @@ -618,13 +646,14 @@ export abstract class Expression * Creates an expression that checks if this expression is equal to any of the provided values or * expressions. * + * @example * ```typescript * // Check if the 'category' field is either "Electronics" or value of field 'primaryType' * field("category").equalAny("Electronics", field("primaryType")); * ``` * * @param values The values or expressions to check against. - * @return A new `Expression` representing the 'IN' comparison. + * @returns A new `Expression` representing the 'IN' comparison. */ equalAny(values: Array): BooleanExpression; @@ -633,13 +662,14 @@ export abstract class Expression * Creates an expression that checks if this expression is equal to any of the provided values or * expressions. * + * @example * ```typescript * // Check if the 'category' field is either "Electronics" or value of field 'primaryType' * field("category").equalAny(array(["Electronics", field("primaryType")])); * ``` * * @param arrayExpression An expression that evaluates to an array of values to check against. - * @return A new `Expression` representing the 'IN' comparison. + * @returns A new `Expression` representing the 'IN' comparison. */ equalAny(arrayExpression: Expression): BooleanExpression; equalAny(others: unknown[] | Expression): BooleanExpression { @@ -654,13 +684,14 @@ export abstract class Expression * Creates an expression that checks if this expression is not equal to any of the provided values or * expressions. * + * @example * ```typescript * // Check if the 'status' field is neither "pending" nor the value of 'rejectedStatus' * field("status").notEqualAny(["pending", field("rejectedStatus")]); * ``` * * @param values The values or expressions to check against. - * @return A new `Expression` representing the 'NotEqAny' comparison. + * @returns A new `Expression` representing the 'NotEqAny' comparison. */ notEqualAny(values: Array): BooleanExpression; @@ -668,13 +699,14 @@ export abstract class Expression * @beta * Creates an expression that checks if this expression is not equal to any of the values in the evaluated expression. * + * @example * ```typescript * // Check if the 'status' field is not equal to any value in the field 'rejectedStatuses' * field("status").notEqualAny(field('rejectedStatuses')); * ``` * * @param arrayExpression The values or expressions to check against. - * @return A new `Expression` representing the 'NotEqAny' comparison. + * @returns A new `Expression` representing the 'NotEqAny' comparison. */ notEqualAny(arrayExpression: Expression): BooleanExpression; notEqualAny(others: unknown[] | Expression): BooleanExpression { @@ -691,12 +723,13 @@ export abstract class Expression * @beta * Creates an expression that checks if a field exists in the document. * + * @example * ```typescript * // Check if the document has a field named "phoneNumber" * field("phoneNumber").exists(); * ``` * - * @return A new `Expression` representing the 'exists' check. + * @returns A new `Expression` representing the 'exists' check. */ exists(): BooleanExpression { return new FunctionExpression('exists', [this]).asBoolean(); @@ -706,12 +739,13 @@ export abstract class Expression * @beta * Creates an expression that calculates the character length of a string in UTF-8. * + * @example * ```typescript * // Get the character length of the 'name' field in its UTF-8 form. * field("name").charLength(); * ``` * - * @return A new `Expression` representing the length of the string. + * @returns A new `Expression` representing the length of the string. */ charLength(): FunctionExpression { return new FunctionExpression('char_length', [this]); @@ -721,13 +755,14 @@ export abstract class Expression * @beta * Creates an expression that performs a case-sensitive string comparison. * + * @example * ```typescript * // Check if the 'title' field contains the word "guide" (case-sensitive) * field("title").like("%guide%"); * ``` * * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new `Expression` representing the 'like' comparison. + * @returns A new `Expression` representing the 'like' comparison. */ like(pattern: string): BooleanExpression; @@ -735,13 +770,14 @@ export abstract class Expression * @beta * Creates an expression that performs a case-sensitive string comparison. * + * @example * ```typescript * // Check if the 'title' field contains the word "guide" (case-sensitive) * field("title").like("%guide%"); * ``` * * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new `Expression` representing the 'like' comparison. + * @returns A new `Expression` representing the 'like' comparison. */ like(pattern: Expression): BooleanExpression; like(stringOrExpr: string | Expression): BooleanExpression { @@ -756,13 +792,14 @@ export abstract class Expression * Creates an expression that checks if a string contains a specified regular expression as a * substring. * + * @example * ```typescript * // Check if the 'description' field contains "example" (case-insensitive) * field("description").regexContains("(?i)example"); * ``` * * @param pattern The regular expression to use for the search. - * @return A new `Expression` representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ regexContains(pattern: string): BooleanExpression; @@ -771,13 +808,14 @@ export abstract class Expression * Creates an expression that checks if a string contains a specified regular expression as a * substring. * + * @example * ```typescript * // Check if the 'description' field contains the regular expression stored in field 'regex' * field("description").regexContains(field("regex")); * ``` * * @param pattern The regular expression to use for the search. - * @return A new `Expression` representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ regexContains(pattern: Expression): BooleanExpression; regexContains(stringOrExpr: string | Expression): BooleanExpression { @@ -791,13 +829,14 @@ export abstract class Expression * @beta * Creates an expression that checks if a string matches a specified regular expression. * + * @example * ```typescript * // Check if the 'email' field matches a valid email pattern * field("email").regexMatch("[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}"); * ``` * * @param pattern The regular expression to use for the match. - * @return A new `Expression` representing the regular expression match. + * @returns A new `Expression` representing the regular expression match. */ regexMatch(pattern: string): BooleanExpression; @@ -805,13 +844,14 @@ export abstract class Expression * @beta * Creates an expression that checks if a string matches a specified regular expression. * + * @example * ```typescript * // Check if the 'email' field matches a regular expression stored in field 'regex' * field("email").regexMatch(field("regex")); * ``` * * @param pattern The regular expression to use for the match. - * @return A new `Expression` representing the regular expression match. + * @returns A new `Expression` representing the regular expression match. */ regexMatch(pattern: Expression): BooleanExpression; regexMatch(stringOrExpr: string | Expression): BooleanExpression { @@ -825,13 +865,14 @@ export abstract class Expression * @beta * Creates an expression that checks if a string contains a specified substring. * + * @example * ```typescript * // Check if the 'description' field contains "example". * field("description").stringContains("example"); * ``` * * @param substring The substring to search for. - * @return A new `Expression` representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ stringContains(substring: string): BooleanExpression; @@ -839,13 +880,14 @@ export abstract class Expression * @beta * Creates an expression that checks if a string contains the string represented by another expression. * + * @example * ```typescript * // Check if the 'description' field contains the value of the 'keyword' field. * field("description").stringContains(field("keyword")); * ``` * * @param expr The expression representing the substring to search for. - * @return A new `Expression` representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ stringContains(expr: Expression): BooleanExpression; stringContains(stringOrExpr: string | Expression): BooleanExpression { @@ -859,13 +901,14 @@ export abstract class Expression * @beta * Creates an expression that checks if a string starts with a given prefix. * + * @example * ```typescript * // Check if the 'name' field starts with "Mr." * field("name").startsWith("Mr."); * ``` * * @param prefix The prefix to check for. - * @return A new `Expression` representing the 'starts with' comparison. + * @returns A new `Expression` representing the 'starts with' comparison. */ startsWith(prefix: string): BooleanExpression; @@ -874,13 +917,14 @@ export abstract class Expression * Creates an expression that checks if a string starts with a given prefix (represented as an * expression). * + * @example * ```typescript * // Check if the 'fullName' field starts with the value of the 'firstName' field * field("fullName").startsWith(field("firstName")); * ``` * * @param prefix The prefix expression to check for. - * @return A new `Expression` representing the 'starts with' comparison. + * @returns A new `Expression` representing the 'starts with' comparison. */ startsWith(prefix: Expression): BooleanExpression; startsWith(stringOrExpr: string | Expression): BooleanExpression { @@ -894,13 +938,14 @@ export abstract class Expression * @beta * Creates an expression that checks if a string ends with a given postfix. * + * @example * ```typescript * // Check if the 'filename' field ends with ".txt" * field("filename").endsWith(".txt"); * ``` * * @param suffix The postfix to check for. - * @return A new `Expression` representing the 'ends with' comparison. + * @returns A new `Expression` representing the 'ends with' comparison. */ endsWith(suffix: string): BooleanExpression; @@ -909,13 +954,14 @@ export abstract class Expression * Creates an expression that checks if a string ends with a given postfix (represented as an * expression). * + * @example * ```typescript * // Check if the 'url' field ends with the value of the 'extension' field * field("url").endsWith(field("extension")); * ``` * * @param suffix The postfix expression to check for. - * @return A new `Expression` representing the 'ends with' comparison. + * @returns A new `Expression` representing the 'ends with' comparison. */ endsWith(suffix: Expression): BooleanExpression; endsWith(stringOrExpr: string | Expression): BooleanExpression { @@ -929,12 +975,13 @@ export abstract class Expression * @beta * Creates an expression that converts a string to lowercase. * + * @example * ```typescript * // Convert the 'name' field to lowercase * field("name").toLower(); * ``` * - * @return A new `Expression` representing the lowercase string. + * @returns A new `Expression` representing the lowercase string. */ toLower(): FunctionExpression { return new FunctionExpression('to_lower', [this]); @@ -944,12 +991,13 @@ export abstract class Expression * @beta * Creates an expression that converts a string to uppercase. * + * @example * ```typescript * // Convert the 'title' field to uppercase * field("title").toUpper(); * ``` * - * @return A new `Expression` representing the uppercase string. + * @returns A new `Expression` representing the uppercase string. */ toUpper(): FunctionExpression { return new FunctionExpression('to_upper', [this]); @@ -959,6 +1007,7 @@ export abstract class Expression * @beta * Creates an expression that removes leading and trailing characters from a string or byte array. * + * @example * ```typescript * // Trim whitespace from the 'userInput' field * field("userInput").trim(); @@ -968,7 +1017,7 @@ export abstract class Expression * ``` * @param valueToTrim Optional This parameter is treated as a set of characters or bytes that will be * trimmed from the input. If not specified, then whitespace will be trimmed. - * @return A new `Expr` representing the trimmed string or byte array. + * @returns A new `Expr` representing the trimmed string or byte array. */ trim( valueToTrim?: string | Expression | Uint8Array | Buffer, @@ -984,6 +1033,7 @@ export abstract class Expression * @beta * Creates an expression that concatenates string expressions together. * + * @example * ```typescript * // Combine the 'firstName', " ", and 'lastName' fields into a single string * field("firstName").stringConcat(constant(" "), field("lastName")); @@ -991,7 +1041,7 @@ export abstract class Expression * * @param secondString The additional expression or string literal to concatenate. * @param otherStrings Optional additional expressions or string literals to concatenate. - * @return A new `Expression` representing the concatenated string. + * @returns A new `Expression` representing the concatenated string. */ stringConcat( secondString: Expression | string, @@ -1006,6 +1056,7 @@ export abstract class Expression * @beta * Creates an expression that concatenates expression results together. * + * @example * ```typescript * // Combine the 'firstName', ' ', and 'lastName' fields into a single value. * field("firstName").concat(constant(" "), field("lastName")); @@ -1013,7 +1064,7 @@ export abstract class Expression * * @param second The additional expression or literal to concatenate. * @param others Optional additional expressions or literals to concatenate. - * @return A new `Expr` representing the concatenated value. + * @returns A new `Expr` representing the concatenated value. */ concat( second: Expression | unknown, @@ -1028,12 +1079,13 @@ export abstract class Expression * @beta * Creates an expression that reverses this string or bytes expression. * + * @example * ```typescript * // Reverse the value of the 'myString' field. * field("myString").reverse(); * ``` * - * @return A new {@code Expression} representing the reversed string or bytes. + * @returns A new `Expression` representing the reversed string or bytes. */ reverse(): FunctionExpression { return new FunctionExpression('reverse', [this]); @@ -1043,12 +1095,13 @@ export abstract class Expression * @beta * Creates an expression that calculates the length of this string expression in bytes. * + * @example * ```typescript * // Calculate the length of the 'myString' field in bytes. * field("myString").byteLength(); * ``` * - * @return A new {@code Expression} representing the length of the string in bytes. + * @returns A new `Expression` representing the length of the string in bytes. */ byteLength(): FunctionExpression { return new FunctionExpression('byte_length', [this]); @@ -1058,12 +1111,13 @@ export abstract class Expression * @beta * Creates an expression that computes the ceiling of a numeric value. * + * @example * ```typescript * // Compute the ceiling of the 'price' field. * field("price").ceil(); * ``` * - * @return A new {@code Expression} representing the ceiling of the numeric value. + * @returns A new `Expression` representing the ceiling of the numeric value. */ ceil(): FunctionExpression { return new FunctionExpression('ceil', [this]); @@ -1073,12 +1127,13 @@ export abstract class Expression * @beta * Creates an expression that computes the floor of a numeric value. * + * @example * ```typescript * // Compute the floor of the 'price' field. * field("price").floor(); * ``` * - * @return A new {@code Expression} representing the floor of the numeric value. + * @returns A new `Expression` representing the floor of the numeric value. */ floor(): FunctionExpression { return new FunctionExpression('floor', [this]); @@ -1088,12 +1143,13 @@ export abstract class Expression * @beta * Creates an expression that computes the absolute value of a numeric value. * + * @example * ```typescript * // Compute the absolute value of the 'price' field. * field("price").abs(); * ``` * - * @return A new {@code Expr} representing the absolute value of the numeric value. + * @returns A new `Expr` representing the absolute value of the numeric value. */ abs(): FunctionExpression { return new FunctionExpression('abs', [this]); @@ -1103,12 +1159,13 @@ export abstract class Expression * @beta * Creates an expression that computes e to the power of this expression. * + * @example * ```typescript * // Compute e to the power of the 'value' field. * field("value").exp(); * ``` * - * @return A new {@code Expression} representing the exp of the numeric value. + * @returns A new `Expression` representing the exp of the numeric value. */ exp(): FunctionExpression { return new FunctionExpression('exp', [this]); @@ -1118,13 +1175,14 @@ export abstract class Expression * @beta * Accesses a value from a map (object) field using the provided key. * + * @example * ```typescript * // Get the 'city' value from the 'address' map field * field("address").mapGet("city"); * ``` * * @param subfield The key to access in the map. - * @return A new `Expression` representing the value associated with the given key in the map. + * @returns A new `Expression` representing the value associated with the given key in the map. */ mapGet(subfield: string): FunctionExpression { return new FunctionExpression('map_get', [this, constant(subfield)]); @@ -1135,12 +1193,13 @@ export abstract class Expression * Creates an aggregation that counts the number of stage inputs with valid evaluations of the * expression or field. * + * @example * ```typescript * // Count the total number of products * field("productId").count().as("totalProducts"); * ``` * - * @return A new `AggregateFunction` representing the 'count' aggregation. + * @returns A new `AggregateFunction` representing the 'count' aggregation. */ count(): AggregateFunction { return new AggregateFunction('count', [this]); @@ -1150,12 +1209,13 @@ export abstract class Expression * @beta * Creates an aggregation that calculates the sum of a numeric field across multiple stage inputs. * + * @example * ```typescript * // Calculate the total revenue from a set of orders * field("orderAmount").sum().as("totalRevenue"); * ``` * - * @return A new `AggregateFunction` representing the 'sum' aggregation. + * @returns A new `AggregateFunction` representing the 'sum' aggregation. */ sum(): AggregateFunction { return new AggregateFunction('sum', [this]); @@ -1166,12 +1226,13 @@ export abstract class Expression * Creates an aggregation that calculates the average (mean) of a numeric field across multiple * stage inputs. * + * @example * ```typescript * // Calculate the average age of users * field("age").average().as("averageAge"); * ``` * - * @return A new `AggregateFunction` representing the 'average' aggregation. + * @returns A new `AggregateFunction` representing the 'average' aggregation. */ average(): AggregateFunction { return new AggregateFunction('average', [this]); @@ -1181,12 +1242,13 @@ export abstract class Expression * @beta * Creates an aggregation that finds the minimum value of a field across multiple stage inputs. * + * @example * ```typescript * // Find the lowest price of all products * field("price").minimum().as("lowestPrice"); * ``` * - * @return A new `AggregateFunction` representing the 'min' aggregation. + * @returns A new `AggregateFunction` representing the 'min' aggregation. */ minimum(): AggregateFunction { return new AggregateFunction('minimum', [this]); @@ -1196,12 +1258,13 @@ export abstract class Expression * @beta * Creates an aggregation that finds the maximum value of a field across multiple stage inputs. * + * @example * ```typescript * // Find the highest score in a leaderboard * field("score").maximum().as("highestScore"); * ``` * - * @return A new `AggregateFunction` representing the 'max' aggregation. + * @returns A new `AggregateFunction` representing the 'max' aggregation. */ maximum(): AggregateFunction { return new AggregateFunction('maximum', [this]); @@ -1211,12 +1274,13 @@ export abstract class Expression * @beta * Creates an aggregation that counts the number of distinct values of the expression or field. * + * @example * ```typescript * // Count the distinct number of products * field("productId").countDistinct().as("distinctProducts"); * ``` * - * @return A new `AggregateFunction` representing the 'count_distinct' aggregation. + * @returns A new `AggregateFunction` representing the 'count_distinct' aggregation. */ countDistinct(): AggregateFunction { return new AggregateFunction('count_distinct', [this]); @@ -1226,6 +1290,7 @@ export abstract class Expression * @beta * Creates an expression that returns the larger value between this expression and another expression, based on Firestore's value type ordering. * + * @example * ```typescript * // Returns the larger value between the 'timestamp' field and the current timestamp. * field("timestamp").logicalMaximum(Function.currentTimestamp()); @@ -1233,7 +1298,7 @@ export abstract class Expression * * @param second The second expression or literal to compare with. * @param others Optional additional expressions or literals to compare with. - * @return A new {@code Expression} representing the logical max operation. + * @returns A new `Expression` representing the logical max operation. */ logicalMaximum( second: Expression | unknown, @@ -1250,6 +1315,7 @@ export abstract class Expression * @beta * Creates an expression that returns the smaller value between this expression and another expression, based on Firestore's value type ordering. * + * @example * ```typescript * // Returns the smaller value between the 'timestamp' field and the current timestamp. * field("timestamp").logicalMinimum(Function.currentTimestamp()); @@ -1257,7 +1323,7 @@ export abstract class Expression * * @param second The second expression or literal to compare with. * @param others Optional additional expressions or literals to compare with. - * @return A new {@code Expression} representing the logical min operation. + * @returns A new `Expression` representing the logical min operation. */ logicalMinimum( second: Expression | unknown, @@ -1274,12 +1340,13 @@ export abstract class Expression * @beta * Creates an expression that calculates the length (number of dimensions) of this Firestore Vector expression. * + * @example * ```typescript * // Get the vector length (dimension) of the field 'embedding'. * field("embedding").vectorLength(); * ``` * - * @return A new {@code Expression} representing the length of the vector. + * @returns A new `Expression` representing the length of the vector. */ vectorLength(): FunctionExpression { return new FunctionExpression('vector_length', [this]); @@ -1289,26 +1356,28 @@ export abstract class Expression * @beta * Calculates the cosine distance between two vectors. * + * @example * ```typescript * // Calculate the cosine distance between the 'userVector' field and the 'itemVector' field * field("userVector").cosineDistance(field("itemVector")); * ``` * * @param vectorExpression The other vector (represented as an Expression) to compare against. - * @return A new `Expression` representing the cosine distance between the two vectors. + * @returns A new `Expression` representing the cosine distance between the two vectors. */ cosineDistance(vectorExpression: Expression): FunctionExpression; /** * @beta * Calculates the Cosine distance between two vectors. * + * @example * ```typescript * // Calculate the Cosine distance between the 'location' field and a target location * field("location").cosineDistance(new VectorValue([37.7749, -122.4194])); * ``` * * @param vector The other vector (as a VectorValue) to compare against. - * @return A new `Expression` representing the Cosine* distance between the two vectors. + * @returns A new `Expression` representing the Cosine distance between the two vectors. */ cosineDistance(vector: firestore.VectorValue | number[]): FunctionExpression; cosineDistance( @@ -1324,13 +1393,14 @@ export abstract class Expression * @beta * Calculates the dot product between two vectors. * + * @example * ```typescript * // Calculate the dot product between a feature vector and a target vector * field("features").dotProduct([0.5, 0.8, 0.2]); * ``` * * @param vectorExpression The other vector (as an array of numbers) to calculate with. - * @return A new `Expression` representing the dot product between the two vectors. + * @returns A new `Expression` representing the dot product between the two vectors. */ dotProduct(vectorExpression: Expression): FunctionExpression; @@ -1338,13 +1408,14 @@ export abstract class Expression * @beta * Calculates the dot product between two vectors. * + * @example * ```typescript * // Calculate the dot product between a feature vector and a target vector * field("features").dotProduct(new VectorValue([0.5, 0.8, 0.2])); * ``` * * @param vector The other vector (as an array of numbers) to calculate with. - * @return A new `Expression` representing the dot product between the two vectors. + * @returns A new `Expression` representing the dot product between the two vectors. */ dotProduct(vector: firestore.VectorValue | number[]): FunctionExpression; dotProduct( @@ -1357,13 +1428,14 @@ export abstract class Expression * @beta * Calculates the Euclidean distance between two vectors. * + * @example * ```typescript * // Calculate the Euclidean distance between the 'location' field and a target location * field("location").euclideanDistance([37.7749, -122.4194]); * ``` * * @param vectorExpression The other vector (as an array of numbers) to calculate with. - * @return A new `Expression` representing the Euclidean distance between the two vectors. + * @returns A new `Expression` representing the Euclidean distance between the two vectors. */ euclideanDistance(vectorExpression: Expression): FunctionExpression; @@ -1371,13 +1443,14 @@ export abstract class Expression * @beta * Calculates the Euclidean distance between two vectors. * + * @example * ```typescript * // Calculate the Euclidean distance between the 'location' field and a target location * field("location").euclideanDistance(new VectorValue([37.7749, -122.4194])); * ``` * * @param vector The other vector (as a VectorValue) to compare against. - * @return A new `Expression` representing the Euclidean distance between the two vectors. + * @returns A new `Expression` representing the Euclidean distance between the two vectors. */ euclideanDistance( vector: firestore.VectorValue | number[], @@ -1396,12 +1469,13 @@ export abstract class Expression * Creates an expression that interprets this expression as the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC) * and returns a timestamp. * + * @example * ```typescript * // Interpret the 'microseconds' field as microseconds since epoch. * field("microseconds").unixMicrosToTimestamp(); * ``` * - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ unixMicrosToTimestamp(): FunctionExpression { return new FunctionExpression('unix_micros_to_timestamp', [this]); @@ -1411,12 +1485,13 @@ export abstract class Expression * @beta * Creates an expression that converts this timestamp expression to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC). * + * @example * ```typescript * // Convert the 'timestamp' field to microseconds since epoch. * field("timestamp").timestampToUnixMicros(); * ``` * - * @return A new {@code Expression} representing the number of microseconds since epoch. + * @returns A new `Expression` representing the number of microseconds since epoch. */ timestampToUnixMicros(): FunctionExpression { return new FunctionExpression('timestamp_to_unix_micros', [this]); @@ -1427,12 +1502,13 @@ export abstract class Expression * Creates an expression that interprets this expression as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) * and returns a timestamp. * + * @example * ```typescript * // Interpret the 'milliseconds' field as milliseconds since epoch. * field("milliseconds").unixMillisToTimestamp(); * ``` * - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ unixMillisToTimestamp(): FunctionExpression { return new FunctionExpression('unix_millis_to_timestamp', [this]); @@ -1442,12 +1518,13 @@ export abstract class Expression * @beta * Creates an expression that converts this timestamp expression to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC). * + * @example * ```typescript * // Convert the 'timestamp' field to milliseconds since epoch. * field("timestamp").timestampToUnixMillis(); * ``` * - * @return A new {@code Expression} representing the number of milliseconds since epoch. + * @returns A new `Expression` representing the number of milliseconds since epoch. */ timestampToUnixMillis(): FunctionExpression { return new FunctionExpression('timestamp_to_unix_millis', [this]); @@ -1458,12 +1535,13 @@ export abstract class Expression * Creates an expression that interprets this expression as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) * and returns a timestamp. * + * @example * ```typescript * // Interpret the 'seconds' field as seconds since epoch. * field("seconds").unixSecondsToTimestamp(); * ``` * - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ unixSecondsToTimestamp(): FunctionExpression { return new FunctionExpression('unix_seconds_to_timestamp', [this]); @@ -1473,12 +1551,13 @@ export abstract class Expression * @beta * Creates an expression that converts this timestamp expression to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC). * + * @example * ```typescript * // Convert the 'timestamp' field to seconds since epoch. * field("timestamp").timestampToUnixSeconds(); * ``` * - * @return A new {@code Expression} representing the number of seconds since epoch. + * @returns A new `Expression` representing the number of seconds since epoch. */ timestampToUnixSeconds(): FunctionExpression { return new FunctionExpression('timestamp_to_unix_seconds', [this]); @@ -1488,6 +1567,7 @@ export abstract class Expression * @beta * Creates an expression that adds a specified amount of time to this timestamp expression. * + * @example * ```typescript * // Add some duration determined by field 'unit' and 'amount' to the 'timestamp' field. * field("timestamp").timestampAdd(field("unit"), field("amount")); @@ -1495,7 +1575,7 @@ export abstract class Expression * * @param unit The expression evaluates to unit of time, must be one of 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'day'. * @param amount The expression evaluates to amount of the unit. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ timestampAdd(unit: Expression, amount: Expression): FunctionExpression; @@ -1503,6 +1583,7 @@ export abstract class Expression * @beta * Creates an expression that adds a specified amount of time to this timestamp expression. * + * @example * ```typescript * // Add 1 day to the 'timestamp' field. * field("timestamp").timestampAdd("day", 1); @@ -1510,7 +1591,7 @@ export abstract class Expression * * @param unit The unit of time to add (e.g., "day", "hour"). * @param amount The amount of time to add. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ timestampAdd( unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day', @@ -1538,6 +1619,7 @@ export abstract class Expression * @beta * Creates an expression that subtracts a specified amount of time from this timestamp expression. * + * @example * ```typescript * // Subtract some duration determined by field 'unit' and 'amount' from the 'timestamp' field. * field("timestamp").timestampSubtract(field("unit"), field("amount")); @@ -1545,7 +1627,7 @@ export abstract class Expression * * @param unit The expression evaluates to unit of time, must be one of 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'day'. * @param amount The expression evaluates to amount of the unit. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ timestampSubtract(unit: Expression, amount: Expression): FunctionExpression; @@ -1553,6 +1635,7 @@ export abstract class Expression * @beta * Creates an expression that subtracts a specified amount of time from this timestamp expression. * + * @example * ```typescript * // Subtract 1 day from the 'timestamp' field. * field("timestamp").timestampSubtract("day", 1); @@ -1560,7 +1643,7 @@ export abstract class Expression * * @param unit The unit of time to subtract (e.g., "day", "hour"). * @param amount The amount of time to subtract. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ timestampSubtract( unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day', @@ -1588,12 +1671,13 @@ export abstract class Expression * @beta * Creates an expression that returns the document ID from a path. * + * @example * ```typescript * // Get the document ID from a path. * field("__path__").documentId(); * ``` * - * @return A new {@code Expression} representing the documentId operation. + * @returns A new `Expression` representing the documentId operation. */ documentId(): FunctionExpression { return new FunctionExpression('document_id', [this]); @@ -1640,13 +1724,14 @@ export abstract class Expression * and returns the element. If the index exceeds the array length, an error is * returned. A negative index, starts from the end. * + * @example * ```typescript * // Return the value in the 'tags' field array at index `1`. * field('tags').arrayGet(1); * ``` * * @param index The index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ arrayGet(index: number): FunctionExpression; @@ -1656,6 +1741,7 @@ export abstract class Expression * and returns the element. If the index exceeds the array length, an error is * returned. A negative index, starts from the end. * + * @example * ```typescript * // Return the value in the tags field array at index specified by field * // 'favoriteTag'. @@ -1663,7 +1749,7 @@ export abstract class Expression * ``` * * @param indexExpr An Expression evaluating to the index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ arrayGet(indexExpr: Expression): FunctionExpression; arrayGet(index: Expression | number): FunctionExpression { @@ -1677,12 +1763,13 @@ export abstract class Expression * @beta * Creates an expression that checks if a given expression produces an error. * + * @example * ```typescript * // Check if the result of a calculation is an error * field("title").arrayContains(1).isError(); * ``` * - * @return A new {@code BooleanExpression} representing the 'isError' check. + * @returns A new `BooleanExpression` representing the 'isError' check. */ isError(): BooleanExpression { return new FunctionExpression('is_error', [this]).asBoolean(); @@ -1693,6 +1780,7 @@ export abstract class Expression * Creates an expression that returns the result of the `catchExpr` argument * if there is an error, else return the result of this expression. * + * @example * ```typescript * // Returns the first item in the title field arrays, or returns * // the entire title field if the array is empty or the field is another type. @@ -1701,7 +1789,7 @@ export abstract class Expression * * @param catchExpr The catch expression that will be evaluated and * returned if this expression produces an error. - * @return A new {@code Expression} representing the 'ifError' operation. + * @returns A new `Expression` representing the 'ifError' operation. */ ifError(catchExpr: Expression): FunctionExpression; @@ -1718,7 +1806,7 @@ export abstract class Expression * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expression} representing the 'ifError' operation. + * @returns A new `Expression` representing the 'ifError' operation. */ ifError(catchValue: unknown): FunctionExpression; ifError(catchValue: unknown): FunctionExpression { @@ -1738,7 +1826,7 @@ export abstract class Expression * field("value").isAbsent(); * ``` * - * @return A new {@code BooleanExpression} representing the 'isAbsent' check. + * @returns A new `BooleanExpression` representing the 'isAbsent' check. */ isAbsent(): BooleanExpression { return new FunctionExpression('is_absent', [this]).asBoolean(); @@ -1754,7 +1842,7 @@ export abstract class Expression * ``` * * @param key The name of the key to remove from the input map. - * @returns A new {@code FirestoreFunction} representing the 'mapRemove' operation. + * @returns A new `FirestoreFunction` representing the 'mapRemove' operation. */ mapRemove(key: string): FunctionExpression; /** @@ -1767,7 +1855,7 @@ export abstract class Expression * ``` * * @param keyExpr An expression that produces the name of the key to remove from the input map. - * @returns A new {@code FirestoreFunction} representing the 'mapRemove' operation. + * @returns A new `FirestoreFunction` representing the 'mapRemove' operation. */ mapRemove(keyExpr: Expression): FunctionExpression; mapRemove(stringExpr: Expression | string): FunctionExpression { @@ -1792,7 +1880,7 @@ export abstract class Expression * @param otherMaps Optional additional maps to merge. Each map is represented * as a literal or an expression that returns a map. * - * @returns A new {@code FirestoreFunction} representing the 'mapMerge' operation. + * @returns A new `FirestoreFunction` representing the 'mapMerge' operation. */ mapMerge( secondMap: Record | Expression, @@ -1817,7 +1905,7 @@ export abstract class Expression * ``` * * @param exponent The expression to raise this expression to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ pow(exponent: Expression): FunctionExpression; @@ -1831,7 +1919,7 @@ export abstract class Expression * ``` * * @param exponent The constant value to raise this expression to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ pow(exponent: number): FunctionExpression; pow(exponent: number | Expression): FunctionExpression { @@ -1847,7 +1935,7 @@ export abstract class Expression * field("price").round(); * ``` * - * @return A new `Expression` representing the rounded value. + * @returns A new `Expression` representing the rounded value. */ round(): FunctionExpression; /** @@ -1861,7 +1949,7 @@ export abstract class Expression * * @param decimalPlaces A constant specifying the rounding precision in decimal places. * - * @return A new `Expr` representing the rounded value. + * @returns A new `Expr` representing the rounded value. */ round(decimalPlaces: number): FunctionExpression; /** @@ -1875,7 +1963,7 @@ export abstract class Expression * * @param decimalPlaces An expression specifying the rounding precision in decimal places. * - * @return A new `Expr` representing the rounded value. + * @returns A new `Expr` representing the rounded value. */ round(decimalPlaces: Expression): FunctionExpression; round(decimalPlaces?: number | Expression): FunctionExpression { @@ -1898,7 +1986,7 @@ export abstract class Expression * field("__path__").collectionId(); * ``` * - * @return A new {@code Expression} representing the collectionId operation. + * @returns A new `Expression` representing the collectionId operation. */ collectionId(): FunctionExpression { return new FunctionExpression('collection_id', [this]); @@ -1916,7 +2004,7 @@ export abstract class Expression * field("cart").length(); * ``` * - * @return A new `Expression` representing the length of the string, array, map, vector, or bytes. + * @returns A new `Expression` representing the length of the string, array, map, vector, or bytes. */ length(): FunctionExpression { return new FunctionExpression('length', [this]); @@ -1931,7 +2019,7 @@ export abstract class Expression * field("value").ln(); * ``` * - * @return A new {@code Expression} representing the natural logarithm of the numeric value. + * @returns A new `Expression` representing the natural logarithm of the numeric value. */ ln(): FunctionExpression { return new FunctionExpression('ln', [this]); @@ -1946,7 +2034,7 @@ export abstract class Expression * field("value").sqrt(); * ``` * - * @return A new {@code Expression} representing the square root of the numeric value. + * @returns A new `Expression` representing the square root of the numeric value. */ sqrt(): FunctionExpression { return new FunctionExpression('sqrt', [this]); @@ -1961,7 +2049,7 @@ export abstract class Expression * field("myString").stringReverse(); * ``` * - * @return A new {@code Expression} representing the reversed string. + * @returns A new `Expression` representing the reversed string. */ stringReverse(): FunctionExpression { return new FunctionExpression('string_reverse', [this]); @@ -1979,7 +2067,7 @@ export abstract class Expression * ``` * * @param elseValue The value that will be returned if this Expression evaluates to an absent value. - * @return A new [Expression] representing the ifAbsent operation. + * @returns A new [Expression] representing the ifAbsent operation. */ ifAbsent(elseValue: unknown): Expression; @@ -1995,7 +2083,7 @@ export abstract class Expression * ``` * * @param elseExpression The Expression that will be evaluated if this Expression evaluates to an absent value. - * @return A new [Expression] representing the ifAbsent operation. + * @returns A new [Expression] representing the ifAbsent operation. */ ifAbsent(elseExpression: unknown): Expression; @@ -2016,7 +2104,7 @@ export abstract class Expression * ``` * * @param delimiterExpression The expression that evaluates to the delimiter string. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ join(delimiterExpression: Expression): Expression; @@ -2030,7 +2118,7 @@ export abstract class Expression * ``` * * @param delimiter The string to use as a delimiter. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ join(delimiter: string): Expression; @@ -2050,7 +2138,7 @@ export abstract class Expression * field("value").log10(); * ``` * - * @return A new {@code Expr} representing the base-10 logarithm of the numeric value. + * @returns A new `Expr` representing the base-10 logarithm of the numeric value. */ log10(): FunctionExpression { return new FunctionExpression('log10', [this]); @@ -2065,7 +2153,7 @@ export abstract class Expression * field("scores").arraySum(); * ``` * - * @return A new {@code Expr} representing the sum of the elements in the array. + * @returns A new `Expr` representing the sum of the elements in the array. */ arraySum(): FunctionExpression { return new FunctionExpression('sum', [this]); @@ -2082,7 +2170,7 @@ export abstract class Expression * field('scoresCsv').split(',') * ``` * - * @return A new {@code Expression} representing the split function. + * @returns A new `Expression` representing the split function. */ split(delimiter: string): FunctionExpression; @@ -2097,7 +2185,7 @@ export abstract class Expression * field('scores').split(conditional(field('format').equal('csv'), constant(','), constant(':')) * ``` * - * @return A new {@code Expression} representing the split function. + * @returns A new `Expression` representing the split function. */ split(delimiter: Expression): FunctionExpression; split(delimiter: string | Expression): FunctionExpression { @@ -2119,7 +2207,7 @@ export abstract class Expression * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ timestampTruncate( granularity: firestore.Pipelines.TimeGranularity, @@ -2138,7 +2226,7 @@ export abstract class Expression * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ timestampTruncate( granularity: Expression, @@ -2169,7 +2257,7 @@ export abstract class Expression * field('title').type() * ``` * - * @return A new {Expression} representing the data type. + * @returns A new {Expression} representing the data type. */ type(): FunctionExpression { return new FunctionExpression('type', [this]); @@ -2179,7 +2267,7 @@ export abstract class Expression /** * @beta - * Creates an {@link Ordering} that sorts documents in ascending order based on this expression. + * Creates an `Ordering` that sorts documents in ascending order based on this expression. * * ```typescript * // Sort documents by the 'name' field in ascending order @@ -2187,7 +2275,7 @@ export abstract class Expression * .sort(field("name").ascending()); * ``` * - * @return A new `Ordering` for ascending sorting. + * @returns A new `Ordering` for ascending sorting. */ ascending(): Ordering { return ascending(this); @@ -2195,7 +2283,7 @@ export abstract class Expression /** * @beta - * Creates an {@link Ordering} that sorts documents in descending order based on this expression. + * Creates an `Ordering` that sorts documents in descending order based on this expression. * * ```typescript * // Sort documents by the 'createdAt' field in descending order @@ -2203,7 +2291,7 @@ export abstract class Expression * .sort(field("createdAt").descending()); * ``` * - * @return A new `Ordering` for descending sorting. + * @returns A new `Ordering` for descending sorting. */ descending(): Ordering { return descending(this); @@ -2223,7 +2311,7 @@ export abstract class Expression * ``` * * @param name The alias to assign to this expression. - * @return A new {@link AliasedExpression} that wraps this + * @returns A new `AliasedExpression` that wraps this * expression and associates it with the provided alias. */ as(name: string): AliasedExpression { @@ -2275,7 +2363,7 @@ export class AggregateFunction implements AggregateFunction, HasUserData { * ``` * * @param name The alias to assign to this AggregateFunction. - * @return A new {@link AliasedAggregate} that wraps this + * @returns A new `AliasedAggregate` that wraps this * AggregateFunction and associates it with the provided alias. */ as(name: string): AliasedAggregate { @@ -2332,7 +2420,7 @@ export class AliasedAggregate implements AliasedAggregate, HasUserData { * @beta * Represents an expression that has been assigned an alias using the `.as()` method. * - * This class wraps an existing {@link Expression} and associates it with a user-defined alias, + * This class wraps an existing `Expression` and associates it with a user-defined alias, * allowing the expression's result to be referred to by name in the output * of a Firestore pipeline query. */ @@ -2404,12 +2492,12 @@ class ListOfExprs extends Expression { /** * @beta - * Represents a reference to a field in a Firestore document, or outputs of a {@link Pipeline} stage. + * 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 {@link #of} method: + *

You can create a `Field` instance using the static `field` method: * * ```typescript * // Create a Field instance for the 'name' field @@ -2470,7 +2558,7 @@ export class Field /** * @beta - * Creates a {@code Field} instance representing the field at the given path. + * 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"). @@ -2484,7 +2572,7 @@ export class Field * ``` * * @param field The path to the field. - * @return A new {@code Field} instance representing the specified field. + * @returns A new `Field` instance representing the specified field. */ export function field(field: string | firestore.FieldPath): Field { if (typeof field === 'string') { @@ -2502,7 +2590,7 @@ export function field(field: string | firestore.FieldPath): Field { * @internal * Represents a constant value that can be used in a Firestore pipeline expression. * - * You can create a `Constant` instance using the static {@link #of} method: + * You can create a `Constant` instance using the static `field` method: * * ```typescript * // Create a Constant instance for the number 10 @@ -2571,7 +2659,7 @@ export class Constant extends Expression { * Creates an 'Expression' instance for a number value. * * @param value The number value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: number): Expression; @@ -2580,7 +2668,7 @@ export function constant(value: number): Expression; * Creates an 'Expression' instance for a string value. * * @param value The string value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: string): Expression; @@ -2589,7 +2677,7 @@ export function constant(value: string): Expression; * Creates an 'Expression' instance for a boolean value. * * @param value The boolean value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: boolean): BooleanExpression; @@ -2598,7 +2686,7 @@ export function constant(value: boolean): BooleanExpression; * Creates an 'Expression' instance for a null value. * * @param value The null value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: null): Expression; @@ -2607,7 +2695,7 @@ export function constant(value: null): Expression; * Creates an 'Expression' instance for a GeoPoint value. * * @param value The GeoPoint value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: firestore.GeoPoint): Expression; @@ -2616,7 +2704,7 @@ export function constant(value: firestore.GeoPoint): Expression; * Creates an 'Expression' instance for a Timestamp value. * * @param value The Timestamp value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: firestore.Timestamp): Expression; @@ -2625,7 +2713,7 @@ export function constant(value: firestore.Timestamp): Expression; * Creates an 'Expression' instance for a Date value. * * @param value The Date value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: Date): Expression; @@ -2634,7 +2722,7 @@ export function constant(value: Date): Expression; * Creates an 'Expression' instance for a Buffer | Uint8Array value. * * @param value The Buffer | Uint8Array value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: Buffer | Uint8Array): Expression; @@ -2643,7 +2731,7 @@ export function constant(value: Buffer | Uint8Array): Expression; * Creates an 'Expression' instance for a DocumentReference value. * * @param value The DocumentReference value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: firestore.DocumentReference): Expression; @@ -2654,7 +2742,7 @@ export function constant(value: firestore.DocumentReference): Expression; * @private * @internal * @param value The Firestore proto value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: api.IValue): Expression; @@ -2663,7 +2751,7 @@ export function constant(value: api.IValue): Expression; * Creates an 'Expression' instance for a VectorValue value. * * @param value The VectorValue value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: firestore.VectorValue): Expression; @@ -2719,11 +2807,11 @@ export class MapValue extends Expression { /** * @beta - * This class defines the base class for Firestore {@link Pipeline} functions, which can be evaluated within pipeline + * This class defines the base class for Firestore `Pipeline` functions, which can be evaluated within pipeline * execution. * - * Typically, you would not use this class or its children directly. Use either the functions like {@link and}, {@link equal}, - * or the methods on {@link Expression} ({@link Expression#equal}, {@link Expression#lessThan}, etc.) to construct new Function instances. + * Typically, you would not use this class or its children directly. Use either the functions like `and`, `equal`, + * or the methods on `Expression` ({@link Expression#equal}, {@link Expression#lessThan}, etc.) to construct new Function instances. */ export class FunctionExpression extends Expression { readonly expressionType: firestore.Pipelines.ExpressionType = 'Function'; @@ -2763,11 +2851,11 @@ export class FunctionExpression extends Expression { /** * @beta - * This class defines the base class for Firestore {@link Pipeline} functions, which can be evaluated within pipeline + * This class defines the base class for Firestore `Pipeline` functions, which can be evaluated within pipeline * execution. * - * Typically, you would not use this class or its children directly. Use either the functions like {@link and}, {@link equal}, - * or the methods on {@link Expression} ({@link Expression#equal}, {@link Expression#lessThan}, etc.) to construct new Function instances. + * Typically, you would not use this class or its children directly. Use either the functions like `and`, `equal`, + * or the methods on `Expression` ({@link Expression#equal}, {@link Expression#lessThan}, etc.) to construct new Function instances. */ class MapFunctionExpr extends FunctionExpression { readonly expressionType: firestore.Pipelines.ExpressionType = 'Function'; @@ -2815,11 +2903,11 @@ class MapFunctionExpr extends FunctionExpression { /** * @beta - * This class defines the base class for Firestore {@link Pipeline} functions, which can be evaluated within pipeline + * This class defines the base class for Firestore `Pipeline` functions, which can be evaluated within pipeline * execution. * - * Typically, you would not use this class or its children directly. Use either the functions like {@link and}, {@link equal}, - * or the methods on {@link Expression} ({@link Expression#equal}, {@link Expression#lessThan}, etc.) to construct new Function instances. + * Typically, you would not use this class or its children directly. Use either the functions like `and`, `equal`, + * or the methods on `Expression` ({@link Expression#equal}, {@link Expression#lessThan}, etc.) to construct new Function instances. */ class ArrayFunctionExpr extends FunctionExpression { readonly expressionType: firestore.Pipelines.ExpressionType = 'Function'; @@ -2881,7 +2969,7 @@ export abstract class BooleanExpression * field("score").greaterThan(90).countIf().as("highestScore"); * ``` * - * @return A new `AggregateFunction` representing the 'countIf' aggregation. + * @returns A new `AggregateFunction` representing the 'countIf' aggregation. */ countIf(): AggregateFunction { return new AggregateFunction('count_if', [this]); @@ -2896,7 +2984,7 @@ export abstract class BooleanExpression * field("tags").arrayContains("completed").not(); * ``` * - * @return A new {@code Expression} representing the negated filter condition. + * @returns A new `Expression` representing the negated filter condition. */ not(): BooleanExpression { return new FunctionExpression('not', [this]).asBoolean(); @@ -2915,7 +3003,7 @@ export abstract class BooleanExpression * * @param thenExpr The expression to evaluate if the condition is true. * @param elseExpr The expression to evaluate if the condition is false. - * @return A new {@code Expr} representing the conditional expression. + * @returns A new `Expr` representing the conditional expression. */ conditional(thenExpr: Expression, elseExpr: Expression): FunctionExpression { return new FunctionExpression('conditional', [this, thenExpr, elseExpr]); @@ -2935,7 +3023,7 @@ export abstract class BooleanExpression * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new `Expr` representing the 'ifError' operation. */ ifError(catchValue: BooleanExpression): BooleanExpression; @@ -2953,7 +3041,7 @@ export abstract class BooleanExpression * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new `Expr` representing the 'ifError' operation. */ ifError(catchValue: boolean): BooleanExpression; @@ -2970,7 +3058,7 @@ export abstract class BooleanExpression * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new `Expr` representing the 'ifError' operation. */ ifError(catchValue: Expression): FunctionExpression; @@ -2987,7 +3075,7 @@ export abstract class BooleanExpression * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new `Expr` representing the 'ifError' operation. */ ifError(catchValue: unknown): FunctionExpression; ifError(catchValue: unknown): unknown { @@ -3062,7 +3150,7 @@ export function countIf(booleanExpr: BooleanExpression): AggregateFunction { * * @param arrayField The name of the array field. * @param index The index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ export function arrayGet(arrayField: string, index: number): FunctionExpression; @@ -3080,7 +3168,7 @@ export function arrayGet(arrayField: string, index: number): FunctionExpression; * * @param arrayField The name of the array field. * @param indexExpr An Expression evaluating to the index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ export function arrayGet( arrayField: string, @@ -3100,7 +3188,7 @@ export function arrayGet( * * @param arrayExpression An Expression evaluating to an array. * @param index The index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ export function arrayGet( arrayExpression: Expression, @@ -3121,7 +3209,7 @@ export function arrayGet( * * @param arrayExpression An Expression evaluating to an array. * @param indexExpr An Expression evaluating to the index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ export function arrayGet( arrayExpression: Expression, @@ -3144,7 +3232,7 @@ export function arrayGet( * ``` * * @param value The expression to check. - * @return A new {@code Expression} representing the 'isError' check. + * @returns A new `Expression` representing the 'isError' check. */ export function isError(value: Expression): BooleanExpression { const expr: Expression = cast(value); @@ -3168,7 +3256,7 @@ export function isError(value: Expression): BooleanExpression { * @param tryExpr The try expression. * @param catchExpr The catch expression that will be evaluated and * returned if the tryExpr produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new `Expr` representing the 'ifError' operation. */ export function ifError( tryExpr: BooleanExpression, @@ -3190,7 +3278,7 @@ export function ifError( * @param tryExpr The try expression. * @param catchExpr The catch expression that will be evaluated and * returned if the tryExpr produces an error. - * @return A new {@code Expression} representing the 'ifError' operation. + * @returns A new `Expression` representing the 'ifError' operation. */ export function ifError( tryExpr: Expression, @@ -3212,7 +3300,7 @@ export function ifError( * @param tryExpr The try expression. * @param catchValue The value that will be returned if the tryExpr produces an * error. - * @return A new {@code Expression} representing the 'ifError' operation. + * @returns A new `Expression` representing the 'ifError' operation. */ export function ifError( tryExpr: Expression, @@ -3244,7 +3332,7 @@ export function ifError( * ``` * * @param value The expression to check. - * @return A new {@code Expression} representing the 'isAbsent' check. + * @returns A new `Expression` representing the 'isAbsent' check. */ export function isAbsent(value: Expression): BooleanExpression; @@ -3259,7 +3347,7 @@ export function isAbsent(value: Expression): BooleanExpression; * ``` * * @param field The field to check. - * @return A new {@code Expression} representing the 'isAbsent' check. + * @returns A new `Expression` representing the 'isAbsent' check. */ export function isAbsent(field: string): BooleanExpression; export function isAbsent(value: Expression | string): BooleanExpression { @@ -3396,7 +3484,7 @@ export function mapMerge( * documentId(myDocumentReference); * ``` * - * @return A new {@code Expr} representing the documentId operation. + * @returns A new `Expr` representing the documentId operation. */ export function documentId( documentPath: string | firestore.DocumentReference, @@ -3411,7 +3499,7 @@ export function documentId( * documentId(field("__path__")); * ``` * - * @return A new {@code Expression} representing the documentId operation. + * @returns A new `Expression` representing the documentId operation. */ export function documentId(documentPathExpr: Expression): FunctionExpression; export function documentId( @@ -3500,7 +3588,7 @@ export function substring( * * @param first The first expression to add. * @param second The second expression or literal to add. - * @return A new {@code Expression} representing the addition operation. + * @returns A new `Expression` representing the addition operation. */ export function add( first: Expression, @@ -3518,7 +3606,7 @@ export function add( * * @param fieldName The name of the field containing the value to add. * @param second The second expression or literal to add. - * @return A new {@code Expression} representing the addition operation. + * @returns A new `Expression` representing the addition operation. */ export function add( fieldName: string, @@ -3543,7 +3631,7 @@ export function add( * * @param minuend The expression to subtract from. * @param subtrahend The expression to subtract. - * @return A new {@code Expression} representing the subtraction operation. + * @returns A new `Expression` representing the subtraction operation. */ export function subtract( minuend: Expression, @@ -3561,7 +3649,7 @@ export function subtract( * * @param minuend The expression to subtract from. * @param subtrahend The constant value to subtract. - * @return A new {@code Expression} representing the subtraction operation. + * @returns A new `Expression` representing the subtraction operation. */ export function subtract( minuend: Expression, @@ -3579,7 +3667,7 @@ export function subtract( * * @param minuendFieldName The field name to subtract from. * @param subtrahend The expression to subtract. - * @return A new {@code Expression} representing the subtraction operation. + * @returns A new `Expression` representing the subtraction operation. */ export function subtract( minuendFieldName: string, @@ -3597,7 +3685,7 @@ export function subtract( * * @param minuendFieldName The field name to subtract from. * @param subtrahend The constant value to subtract. - * @return A new {@code Expression} representing the subtraction operation. + * @returns A new `Expression` representing the subtraction operation. */ export function subtract( minuendFieldName: string, @@ -3623,7 +3711,7 @@ export function subtract( * * @param first The first expression to multiply. * @param second The second expression or literal to multiply. - * @return A new {@code Expression} representing the multiplication operation. + * @returns A new `Expression` representing the multiplication operation. */ export function multiply( first: Expression, @@ -3641,7 +3729,7 @@ export function multiply( * * @param fieldName The name of the field containing the value to multiply. * @param second The second expression or literal to multiply. - * @return A new {@code Expression} representing the multiplication operation. + * @returns A new `Expression` representing the multiplication operation. */ export function multiply( fieldName: string, @@ -3666,7 +3754,7 @@ export function multiply( * * @param dividend The expression to be divided. * @param divisort The expression to divide by. - * @return A new {@code Expression} representing the division operation. + * @returns A new `Expression` representing the division operation. */ export function divide( dividend: Expression, @@ -3684,7 +3772,7 @@ export function divide( * * @param dividend The expression to be divided. * @param divisor The constant value to divide by. - * @return A new {@code Expression} representing the division operation. + * @returns A new `Expression` representing the division operation. */ export function divide( dividend: Expression, @@ -3702,7 +3790,7 @@ export function divide( * * @param dividend The field name to be divided. * @param divisor The expression to divide by. - * @return A new {@code Expression} representing the division operation. + * @returns A new `Expression` representing the division operation. */ export function divide( dividend: string, @@ -3720,7 +3808,7 @@ export function divide( * * @param dividend The field name to be divided. * @param divisor The constant value to divide by. - * @return A new {@code Expression} representing the division operation. + * @returns A new `Expression` representing the division operation. */ export function divide(dividend: string, divisor: unknown): FunctionExpression; export function divide( @@ -3743,7 +3831,7 @@ export function divide( * * @param left The dividend expression. * @param right The divisor expression. - * @return A new {@code Expression} representing the modulo operation. + * @returns A new `Expression` representing the modulo operation. */ export function mod(left: Expression, right: Expression): FunctionExpression; @@ -3758,7 +3846,7 @@ export function mod(left: Expression, right: Expression): FunctionExpression; * * @param expression The dividend expression. * @param value The divisor constant. - * @return A new {@code Expression} representing the modulo operation. + * @returns A new `Expression` representing the modulo operation. */ export function mod(expression: Expression, value: unknown): FunctionExpression; @@ -3773,7 +3861,7 @@ export function mod(expression: Expression, value: unknown): FunctionExpression; * * @param fieldName The dividend field name. * @param expression The divisor expression. - * @return A new {@code Expression} representing the modulo operation. + * @returns A new `Expression` representing the modulo operation. */ export function mod( fieldName: string, @@ -3791,7 +3879,7 @@ export function mod( * * @param fieldName The dividend field name. * @param value The divisor constant. - * @return A new {@code Expression} representing the modulo operation. + * @returns A new `Expression` representing the modulo operation. */ export function mod(fieldName: string, value: unknown): FunctionExpression; export function mod( @@ -3813,7 +3901,7 @@ export function mod( * ``` * * @param elements The input map to evaluate in the expression. - * @return A new {@code Expression} representing the map function. + * @returns A new `Expression` representing the map function. */ export function map(elements: Record): FunctionExpression { const result: Record = {}; @@ -3862,7 +3950,7 @@ export function _mapValue(plainObject: Record): MapValue { * ``` * * @param elements The input array to evaluate in the expression. - * @return A new {@code Expression} representing the array function. + * @returns A new `Expression` representing the array function. */ export function array(elements: unknown[]): FunctionExpression { return new ArrayFunctionExpr( @@ -3883,7 +3971,7 @@ export function array(elements: unknown[]): FunctionExpression { * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ export function equal(left: Expression, right: Expression): BooleanExpression; @@ -3898,7 +3986,7 @@ export function equal(left: Expression, right: Expression): BooleanExpression; * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ export function equal( expression: Expression, @@ -3916,7 +4004,7 @@ export function equal( * * @param fieldName The field name to compare. * @param expression The expression to compare to. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ export function equal( fieldName: string, @@ -3934,7 +4022,7 @@ export function equal( * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ export function equal(fieldName: string, value: unknown): BooleanExpression; export function equal( @@ -3957,7 +4045,7 @@ export function equal( * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ export function notEqual( left: Expression, @@ -3975,7 +4063,7 @@ export function notEqual( * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ export function notEqual( expression: Expression, @@ -3993,7 +4081,7 @@ export function notEqual( * * @param fieldName The field name to compare. * @param expression The expression to compare to. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ export function notEqual( fieldName: string, @@ -4011,7 +4099,7 @@ export function notEqual( * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ export function notEqual(fieldName: string, value: unknown): BooleanExpression; export function notEqual( @@ -4034,7 +4122,7 @@ export function notEqual( * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ export function lessThan( left: Expression, @@ -4052,7 +4140,7 @@ export function lessThan( * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ export function lessThan( expression: Expression, @@ -4070,7 +4158,7 @@ export function lessThan( * * @param fieldName The field name to compare. * @param expression The expression to compare to. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ export function lessThan( fieldName: string, @@ -4088,7 +4176,7 @@ export function lessThan( * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ export function lessThan(fieldName: string, value: unknown): BooleanExpression; export function lessThan( @@ -4112,7 +4200,7 @@ export function lessThan( * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ export function lessThanOrEqual( left: Expression, @@ -4130,7 +4218,7 @@ export function lessThanOrEqual( * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ export function lessThanOrEqual( expression: Expression, @@ -4148,7 +4236,7 @@ export function lessThanOrEqual( * * @param fieldName The field name to compare. * @param expression The expression to compare to. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ export function lessThanOrEqual( fieldName: string, @@ -4166,7 +4254,7 @@ export function lessThanOrEqual( * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ export function lessThanOrEqual( fieldName: string, @@ -4193,7 +4281,7 @@ export function lessThanOrEqual( * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ export function greaterThan( left: Expression, @@ -4211,7 +4299,7 @@ export function greaterThan( * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ export function greaterThan( expression: Expression, @@ -4229,7 +4317,7 @@ export function greaterThan( * * @param fieldName The field name to compare. * @param expression The expression to compare to. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ export function greaterThan( fieldName: string, @@ -4247,7 +4335,7 @@ export function greaterThan( * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ export function greaterThan( fieldName: string, @@ -4274,7 +4362,7 @@ export function greaterThan( * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ export function greaterThanOrEqual( left: Expression, @@ -4293,7 +4381,7 @@ export function greaterThanOrEqual( * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ export function greaterThanOrEqual( expression: Expression, @@ -4311,7 +4399,7 @@ export function greaterThanOrEqual( * * @param fieldName The field name to compare. * @param value The expression to compare to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ export function greaterThanOrEqual( fieldName: string, @@ -4330,7 +4418,7 @@ export function greaterThanOrEqual( * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ export function greaterThanOrEqual( fieldName: string, @@ -4358,7 +4446,7 @@ export function greaterThanOrEqual( * @param firstArray The first array expression to concatenate to. * @param secondArray The second array expression or array literal to concatenate to. * @param otherArrays Optional additional array expressions or array literals to concatenate. - * @return A new {@code Expr} representing the concatenated array. + * @returns A new `Expr` representing the concatenated array. */ export function arrayConcat( firstArray: Expression, @@ -4379,7 +4467,7 @@ export function arrayConcat( * @param firstArrayField The first array to concatenate to. * @param secondArray The second array expression or array literal to concatenate to. * @param otherArrays Optional additional array expressions or array literals to concatenate. - * @return A new {@code Expr} representing the concatenated array. + * @returns A new `Expr` representing the concatenated array. */ export function arrayConcat( firstArrayField: string, @@ -4410,7 +4498,7 @@ export function arrayConcat( * * @param array The array expression to check. * @param element The element to search for in the array. - * @return A new {@code Expression} representing the 'array_contains' comparison. + * @returns A new `Expression` representing the 'array_contains' comparison. */ export function arrayContains( array: Expression, @@ -4428,7 +4516,7 @@ export function arrayContains( * * @param array The array expression to check. * @param element The element to search for in the array. - * @return A new {@code Expression} representing the 'array_contains' comparison. + * @returns A new `Expression` representing the 'array_contains' comparison. */ export function arrayContains( array: Expression, @@ -4446,7 +4534,7 @@ export function arrayContains( * * @param fieldName The field name to check. * @param element The element to search for in the array. - * @return A new {@code Expression} representing the 'array_contains' comparison. + * @returns A new `Expression` representing the 'array_contains' comparison. */ export function arrayContains( fieldName: string, @@ -4464,7 +4552,7 @@ export function arrayContains( * * @param fieldName The field name to check. * @param element The element to search for in the array. - * @return A new {@code Expression} representing the 'array_contains' comparison. + * @returns A new `Expression` representing the 'array_contains' comparison. */ export function arrayContains( fieldName: string, @@ -4491,7 +4579,7 @@ export function arrayContains( * * @param array The array expression to check. * @param values The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_any' comparison. + * @returns A new `Expression` representing the 'array_contains_any' comparison. */ export function arrayContainsAny( array: Expression, @@ -4511,7 +4599,7 @@ export function arrayContainsAny( * * @param fieldName The field name to check. * @param values The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_any' comparison. + * @returns A new `Expression` representing the 'array_contains_any' comparison. */ export function arrayContainsAny( fieldName: string, @@ -4530,7 +4618,7 @@ export function arrayContainsAny( * * @param array The array expression to check. * @param values An expression that evaluates to an array, whose elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_any' comparison. + * @returns A new `Expression` representing the 'array_contains_any' comparison. */ export function arrayContainsAny( array: Expression, @@ -4550,7 +4638,7 @@ export function arrayContainsAny( * * @param fieldName The field name to check. * @param values An expression that evaluates to an array, whose elements to check for in the array field. - * @return A new {@code Expression} representing the 'array_contains_any' comparison. + * @returns A new `Expression` representing the 'array_contains_any' comparison. */ export function arrayContainsAny( fieldName: string, @@ -4578,7 +4666,7 @@ export function arrayContainsAny( * * @param array The array expression to check. * @param values The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_all' comparison. + * @returns A new `Expression` representing the 'array_contains_all' comparison. */ export function arrayContainsAll( array: Expression, @@ -4597,7 +4685,7 @@ export function arrayContainsAll( * * @param fieldName The field name to check. * @param values The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_all' comparison. + * @returns A new `Expression` representing the 'array_contains_all' comparison. */ export function arrayContainsAll( fieldName: string, @@ -4615,7 +4703,7 @@ export function arrayContainsAll( * * @param array The array expression to check. * @param arrayExpression The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_all' comparison. + * @returns A new `Expression` representing the 'array_contains_all' comparison. */ export function arrayContainsAll( array: Expression, @@ -4634,7 +4722,7 @@ export function arrayContainsAll( * * @param fieldName The field name to check. * @param arrayExpression The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_all' comparison. + * @returns A new `Expression` representing the 'array_contains_all' comparison. */ export function arrayContainsAll( fieldName: string, @@ -4661,7 +4749,7 @@ export function arrayContainsAll( * ``` * * @param fieldName The name of the field containing an array to calculate the length of. - * @return A new {@code Expression} representing the length of the array. + * @returns A new `Expression` representing the length of the array. */ export function arrayLength(fieldName: string): FunctionExpression; @@ -4675,7 +4763,7 @@ export function arrayLength(fieldName: string): FunctionExpression; * ``` * * @param array The array expression to calculate the length of. - * @return A new {@code Expression} representing the length of the array. + * @returns A new `Expression` representing the length of the array. */ export function arrayLength(array: Expression): FunctionExpression; export function arrayLength(array: Expression | string): FunctionExpression { @@ -4694,7 +4782,7 @@ export function arrayLength(array: Expression | string): FunctionExpression { * * @param expression The expression whose results to compare. * @param values The values to check against. - * @return A new {@code Expression} representing the 'IN' comparison. + * @returns A new `Expression` representing the 'IN' comparison. */ export function equalAny( expression: Expression, @@ -4712,7 +4800,7 @@ export function equalAny( * * @param expression The expression whose results to compare. * @param arrayExpression An expression that evaluates to an array, whose elements to check for equality to the input. - * @return A new {@code Expression} representing the 'IN' comparison. + * @returns A new `Expression` representing the 'IN' comparison. */ export function equalAny( expression: Expression, @@ -4731,7 +4819,7 @@ export function equalAny( * * @param fieldName The field to compare. * @param values The values to check against. - * @return A new {@code Expression} representing the 'IN' comparison. + * @returns A new `Expression` representing the 'IN' comparison. */ export function equalAny( fieldName: string, @@ -4750,7 +4838,7 @@ export function equalAny( * * @param fieldName The field to compare. * @param arrayExpression An expression that evaluates to an array, whose elements to check for equality to the input field. - * @return A new {@code Expression} representing the 'IN' comparison. + * @returns A new `Expression` representing the 'IN' comparison. */ export function equalAny( fieldName: string, @@ -4779,7 +4867,7 @@ export function equalAny( * * @param element The expression to compare. * @param values The values to check against. - * @return A new {@code Expression} representing the 'NOT IN' comparison. + * @returns A new `Expression` representing the 'NOT IN' comparison. */ export function notEqualAny( element: Expression, @@ -4798,7 +4886,7 @@ export function notEqualAny( * * @param fieldName The field name to compare. * @param values The values to check against. - * @return A new {@code Expression} representing the 'NOT IN' comparison. + * @returns A new `Expression` representing the 'NOT IN' comparison. */ export function notEqualAny( fieldName: string, @@ -4817,7 +4905,7 @@ export function notEqualAny( * * @param element The expression to compare. * @param arrayExpression The values to check against. - * @return A new {@code Expression} representing the 'NOT IN' comparison. + * @returns A new `Expression` representing the 'NOT IN' comparison. */ export function notEqualAny( element: Expression, @@ -4835,7 +4923,7 @@ export function notEqualAny( * * @param fieldName The field name to compare. * @param arrayExpression The values to check against. - * @return A new {@code Expression} representing the 'NOT IN' comparison. + * @returns A new `Expression` representing the 'NOT IN' comparison. */ export function notEqualAny( fieldName: string, @@ -4869,7 +4957,7 @@ export function notEqualAny( * @param first The first condition. * @param second The second condition. * @param additionalConditions Additional conditions to 'XOR' together. - * @return A new {@code Expression} representing the logical 'XOR' operation. + * @returns A new `Expression` representing the logical 'XOR' operation. */ export function xor( first: BooleanExpression, @@ -4897,7 +4985,7 @@ export function xor( * @param condition The condition to evaluate. * @param thenExpr The expression to evaluate if the condition is true. * @param elseExpr The expression to evaluate if the condition is false. - * @return A new {@code Expression} representing the conditional expression. + * @returns A new `Expression` representing the conditional expression. */ export function conditional( condition: BooleanExpression, @@ -4921,7 +5009,7 @@ export function conditional( * ``` * * @param booleanExpr The filter condition to negate. - * @return A new {@code Expression} representing the negated filter condition. + * @returns A new `Expression` representing the negated filter condition. */ export function not(booleanExpr: BooleanExpression): BooleanExpression { return booleanExpr.not(); @@ -4941,7 +5029,7 @@ export function not(booleanExpr: BooleanExpression): BooleanExpression { * @param first The first operand expression. * @param second The second expression or literal. * @param others Optional additional expressions or literals. - * @return A new {@code Expression} representing the logical max operation. + * @returns A new `Expression` representing the logical max operation. */ export function logicalMaximum( first: Expression, @@ -4963,7 +5051,7 @@ export function logicalMaximum( * @param fieldName The first operand field name. * @param second The second expression or literal. * @param others Optional additional expressions or literals. - * @return A new {@code Expression} representing the logical max operation. + * @returns A new `Expression` representing the logical max operation. */ export function logicalMaximum( fieldName: string, @@ -4996,7 +5084,7 @@ export function logicalMaximum( * @param first The first operand expression. * @param second The second expression or literal. * @param others Optional additional expressions or literals. - * @return A new {@code Expression} representing the logical min operation. + * @returns A new `Expression` representing the logical min operation. */ export function logicalMinimum( first: Expression, @@ -5019,7 +5107,7 @@ export function logicalMinimum( * @param fieldName The first operand field name. * @param second The second expression or literal. * @param others Optional additional expressions or literals. - * @return A new {@code Expression} representing the logical min operation. + * @returns A new `Expression` representing the logical min operation. */ export function logicalMinimum( fieldName: string, @@ -5048,7 +5136,7 @@ export function logicalMinimum( * ``` * * @param value An expression evaluates to the name of the field to check. - * @return A new {@code Expression} representing the 'exists' check. + * @returns A new `Expression` representing the 'exists' check. */ export function exists(value: Expression): BooleanExpression; @@ -5062,7 +5150,7 @@ export function exists(value: Expression): BooleanExpression; * ``` * * @param fieldName The field name to check. - * @return A new {@code Expression} representing the 'exists' check. + * @returns A new `Expression` representing the 'exists' check. */ export function exists(fieldName: string): BooleanExpression; export function exists(valueOrField: Expression | string): BooleanExpression { @@ -5079,7 +5167,7 @@ export function exists(valueOrField: Expression | string): BooleanExpression { * ``` * * @param stringExpression An expression evaluating to a string value, which will be reversed. - * @return A new {@code Expression} representing the reversed string. + * @returns A new `Expression` representing the reversed string. */ export function reverse(stringExpression: Expression): FunctionExpression; @@ -5093,7 +5181,7 @@ export function reverse(stringExpression: Expression): FunctionExpression; * ``` * * @param field The name of the field representing the string to reverse. - * @return A new {@code Expression} representing the reversed string. + * @returns A new `Expression` representing the reversed string. */ export function reverse(field: string): FunctionExpression; export function reverse(expr: Expression | string): FunctionExpression { @@ -5110,7 +5198,7 @@ export function reverse(expr: Expression | string): FunctionExpression { * ``` * * @param fieldName The name of the field to reverse. - * @return A new {@code Expression} representing the reversed array. + * @returns A new `Expression` representing the reversed array. */ export function arrayReverse(fieldName: string): FunctionExpression; @@ -5124,7 +5212,7 @@ export function arrayReverse(fieldName: string): FunctionExpression; * ``` * * @param arrayExpression An expression evaluating to an array value, which will be reversed. - * @return A new {@code Expression} representing the reversed array. + * @returns A new `Expression` representing the reversed array. */ export function arrayReverse(arrayExpression: Expression): FunctionExpression; export function arrayReverse(expr: Expression | string): FunctionExpression { @@ -5141,7 +5229,7 @@ export function arrayReverse(expr: Expression | string): FunctionExpression { * ``` * * @param expr The expression representing the string. - * @return A new {@code Expression} representing the length of the string in bytes. + * @returns A new `Expression` representing the length of the string in bytes. */ export function byteLength(expr: Expression): FunctionExpression; @@ -5155,7 +5243,7 @@ export function byteLength(expr: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field containing the string. - * @return A new {@code Expression} representing the length of the string in bytes. + * @returns A new `Expression` representing the length of the string in bytes. */ export function byteLength(fieldName: string): FunctionExpression; export function byteLength(expr: Expression | string): FunctionExpression { @@ -5172,7 +5260,7 @@ export function byteLength(expr: Expression | string): FunctionExpression { * exp(constant(2)); * ``` * - * @return A new {@code Expression} representing the exp of the numeric value. + * @returns A new `Expression` representing the exp of the numeric value. */ export function exp(expression: Expression): FunctionExpression; @@ -5185,7 +5273,7 @@ export function exp(expression: Expression): FunctionExpression; * exp('value'); * ``` * - * @return A new {@code Expression} representing the exp of the numeric value. + * @returns A new `Expression` representing the exp of the numeric value. */ export function exp(fieldName: string): FunctionExpression; @@ -5205,7 +5293,7 @@ export function exp( * ``` * * @param fieldName The name of the field to compute the ceiling of. - * @return A new {@code Expression} representing the ceiling of the numeric value. + * @returns A new `Expression` representing the ceiling of the numeric value. */ export function ceil(fieldName: string): FunctionExpression; @@ -5219,7 +5307,7 @@ export function ceil(fieldName: string): FunctionExpression; * ``` * * @param expression An expression evaluating to a numeric value, which the ceiling will be computed for. - * @return A new {@code Expression} representing the ceiling of the numeric value. + * @returns A new `Expression` representing the ceiling of the numeric value. */ export function ceil(expression: Expression): FunctionExpression; export function ceil(expr: Expression | string): FunctionExpression { @@ -5231,7 +5319,7 @@ export function ceil(expr: Expression | string): FunctionExpression { * Creates an expression that computes the floor of a numeric value. * * @param expr The expression to compute the floor of. - * @return A new {@code Expression} representing the floor of the numeric value. + * @returns A new `Expression` representing the floor of the numeric value. */ export function floor(expr: Expression): FunctionExpression; @@ -5240,7 +5328,7 @@ export function floor(expr: Expression): FunctionExpression; * Creates an expression that computes the floor of a numeric value. * * @param fieldName The name of the field to compute the floor of. - * @return A new {@code Expression} representing the floor of the numeric value. + * @returns A new `Expression` representing the floor of the numeric value. */ export function floor(fieldName: string): FunctionExpression; export function floor(expr: Expression | string): FunctionExpression { @@ -5252,7 +5340,7 @@ export function floor(expr: Expression | string): FunctionExpression { * Creates an aggregation that counts the number of distinct values of a field. * * @param expr The expression or field to count distinct values of. - * @return A new `AggregateFunction` representing the 'count_distinct' aggregation. + * @returns A new `AggregateFunction` representing the 'count_distinct' aggregation. */ export function countDistinct(expr: Expression | string): AggregateFunction { return fieldOrExpression(expr).countDistinct(); @@ -5268,7 +5356,7 @@ export function countDistinct(expr: Expression | string): AggregateFunction { * ``` * * @param fieldName The name of the field containing the string. - * @return A new {@code Expression} representing the length of the string. + * @returns A new `Expression` representing the length of the string. */ export function charLength(fieldName: string): FunctionExpression; @@ -5282,7 +5370,7 @@ export function charLength(fieldName: string): FunctionExpression; * ``` * * @param stringExpression The expression representing the string to calculate the length of. - * @return A new {@code Expression} representing the length of the string. + * @returns A new `Expression` representing the length of the string. */ export function charLength(stringExpression: Expression): FunctionExpression; export function charLength(value: Expression | string): FunctionExpression { @@ -5302,7 +5390,7 @@ export function charLength(value: Expression | string): FunctionExpression { * * @param fieldName The name of the field containing the string. * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new {@code Expression} representing the 'like' comparison. + * @returns A new `Expression` representing the 'like' comparison. */ export function like(fieldName: string, pattern: string): BooleanExpression; @@ -5318,7 +5406,7 @@ export function like(fieldName: string, pattern: string): BooleanExpression; * * @param fieldName The name of the field containing the string. * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new {@code Expression} representing the 'like' comparison. + * @returns A new `Expression` representing the 'like' comparison. */ export function like(fieldName: string, pattern: Expression): BooleanExpression; @@ -5333,7 +5421,7 @@ export function like(fieldName: string, pattern: Expression): BooleanExpression; * * @param stringExpression The expression representing the string to perform the comparison on. * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new {@code Expression} representing the 'like' comparison. + * @returns A new `Expression` representing the 'like' comparison. */ export function like( stringExpression: Expression, @@ -5351,7 +5439,7 @@ export function like( * * @param stringExpression The expression representing the string to perform the comparison on. * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new {@code Expression} representing the 'like' comparison. + * @returns A new `Expression` representing the 'like' comparison. */ export function like( stringExpression: Expression, @@ -5378,7 +5466,7 @@ export function like( * * @param fieldName The name of the field containing the string. * @param pattern The regular expression to use for the search. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ export function regexContains( fieldName: string, @@ -5397,7 +5485,7 @@ export function regexContains( * * @param fieldName The name of the field containing the string. * @param pattern The regular expression to use for the search. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ export function regexContains( fieldName: string, @@ -5416,7 +5504,7 @@ export function regexContains( * * @param stringExpression The expression representing the string to perform the comparison on. * @param pattern The regular expression to use for the search. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ export function regexContains( stringExpression: Expression, @@ -5435,7 +5523,7 @@ export function regexContains( * * @param stringExpression The expression representing the string to perform the comparison on. * @param pattern The regular expression to use for the search. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ export function regexContains( stringExpression: Expression, @@ -5461,7 +5549,7 @@ export function regexContains( * * @param fieldName The name of the field containing the string. * @param pattern The regular expression to use for the match. - * @return A new {@code Expression} representing the regular expression match. + * @returns A new `Expression` representing the regular expression match. */ export function regexMatch( fieldName: string, @@ -5479,7 +5567,7 @@ export function regexMatch( * * @param fieldName The name of the field containing the string. * @param pattern The regular expression to use for the match. - * @return A new {@code Expression} representing the regular expression match. + * @returns A new `Expression` representing the regular expression match. */ export function regexMatch( fieldName: string, @@ -5498,7 +5586,7 @@ export function regexMatch( * * @param stringExpression The expression representing the string to match against. * @param pattern The regular expression to use for the match. - * @return A new {@code Expression} representing the regular expression match. + * @returns A new `Expression` representing the regular expression match. */ export function regexMatch( stringExpression: Expression, @@ -5517,7 +5605,7 @@ export function regexMatch( * * @param stringExpression The expression representing the string to match against. * @param pattern The regular expression to use for the match. - * @return A new {@code Expression} representing the regular expression match. + * @returns A new `Expression` representing the regular expression match. */ export function regexMatch( stringExpression: Expression, @@ -5543,7 +5631,7 @@ export function regexMatch( * * @param fieldName The name of the field containing the string. * @param substring The substring to search for. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ export function stringContains( fieldName: string, @@ -5561,7 +5649,7 @@ export function stringContains( * * @param fieldName The name of the field containing the string. * @param substring The expression representing the substring to search for. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ export function stringContains( fieldName: string, @@ -5579,7 +5667,7 @@ export function stringContains( * * @param stringExpression The expression representing the string to perform the comparison on. * @param substring The substring to search for. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ export function stringContains( stringExpression: Expression, @@ -5597,7 +5685,7 @@ export function stringContains( * * @param stringExpression The expression representing the string to perform the comparison on. * @param substring The expression representing the substring to search for. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ export function stringContains( stringExpression: Expression, @@ -5623,7 +5711,7 @@ export function stringContains( * * @param fieldName The field name to check. * @param prefix The prefix to check for. - * @return A new {@code Expression} representing the 'starts with' comparison. + * @returns A new `Expression` representing the 'starts with' comparison. */ export function startsWith( fieldName: string, @@ -5641,7 +5729,7 @@ export function startsWith( * * @param fieldName The field name to check. * @param prefix The expression representing the prefix. - * @return A new {@code Expression} representing the 'starts with' comparison. + * @returns A new `Expression` representing the 'starts with' comparison. */ export function startsWith( fieldName: string, @@ -5659,7 +5747,7 @@ export function startsWith( * * @param stringExpression The expression to check. * @param prefix The prefix to check for. - * @return A new {@code Expression} representing the 'starts with' comparison. + * @returns A new `Expression` representing the 'starts with' comparison. */ export function startsWith( stringExpression: Expression, @@ -5677,7 +5765,7 @@ export function startsWith( * * @param stringExpression The expression to check. * @param prefix The prefix to check for. - * @return A new {@code Expression} representing the 'starts with' comparison. + * @returns A new `Expression` representing the 'starts with' comparison. */ export function startsWith( stringExpression: Expression, @@ -5701,7 +5789,7 @@ export function startsWith( * * @param fieldName The field name to check. * @param suffix The postfix to check for. - * @return A new {@code Expression} representing the 'ends with' comparison. + * @returns A new `Expression` representing the 'ends with' comparison. */ export function endsWith(fieldName: string, suffix: string): BooleanExpression; @@ -5716,7 +5804,7 @@ export function endsWith(fieldName: string, suffix: string): BooleanExpression; * * @param fieldName The field name to check. * @param suffix The expression representing the postfix. - * @return A new {@code Expression} representing the 'ends with' comparison. + * @returns A new `Expression` representing the 'ends with' comparison. */ export function endsWith( fieldName: string, @@ -5734,7 +5822,7 @@ export function endsWith( * * @param stringExpression The expression to check. * @param suffix The postfix to check for. - * @return A new {@code Expression} representing the 'ends with' comparison. + * @returns A new `Expression` representing the 'ends with' comparison. */ export function endsWith( stringExpression: Expression, @@ -5752,7 +5840,7 @@ export function endsWith( * * @param stringExpression The expression to check. * @param suffix The postfix to check for. - * @return A new {@code Expression} representing the 'ends with' comparison. + * @returns A new `Expression` representing the 'ends with' comparison. */ export function endsWith( stringExpression: Expression, @@ -5775,7 +5863,7 @@ export function endsWith( * ``` * * @param fieldName The name of the field containing the string. - * @return A new {@code Expression} representing the lowercase string. + * @returns A new `Expression` representing the lowercase string. */ export function toLower(fieldName: string): FunctionExpression; @@ -5789,7 +5877,7 @@ export function toLower(fieldName: string): FunctionExpression; * ``` * * @param stringExpression The expression representing the string to convert to lowercase. - * @return A new {@code Expression} representing the lowercase string. + * @returns A new `Expression` representing the lowercase string. */ export function toLower(stringExpression: Expression): FunctionExpression; export function toLower(expr: Expression | string): FunctionExpression { @@ -5806,7 +5894,7 @@ export function toLower(expr: Expression | string): FunctionExpression { * ``` * * @param fieldName The name of the field containing the string. - * @return A new {@code Expression} representing the uppercase string. + * @returns A new `Expression` representing the uppercase string. */ export function toUpper(fieldName: string): FunctionExpression; @@ -5820,7 +5908,7 @@ export function toUpper(fieldName: string): FunctionExpression; * ``` * * @param stringExpression The expression representing the string to convert to uppercase. - * @return A new {@code Expression} representing the uppercase string. + * @returns A new `Expression` representing the uppercase string. */ export function toUpper(stringExpression: Expression): FunctionExpression; export function toUpper(expr: Expression | string): FunctionExpression { @@ -5843,7 +5931,7 @@ export function toUpper(expr: Expression | string): FunctionExpression { * @param fieldName The name of the field containing the string or byte array. * @param valueToTrim Optional This parameter is treated as a set of characters or bytes that will be * trimmed from the input. If not specified, then whitespace will be trimmed. - * @return A new {@code Expr} representing the trimmed string. + * @returns A new `Expr` representing the trimmed string. */ export function trim( fieldName: string, @@ -5866,7 +5954,7 @@ export function trim( * @param stringExpression The expression representing the string or byte array to trim. * @param valueToTrim Optional This parameter is treated as a set of characters or bytes that will be * trimmed from the input. If not specified, then whitespace will be trimmed. - * @return A new {@code Expr} representing the trimmed string or byte array. + * @returns A new `Expr` representing the trimmed string or byte array. */ export function trim( stringExpression: Expression, @@ -5891,7 +5979,7 @@ export function trim( * @param fieldName The field name containing the initial string value. * @param secondString An expression or string literal to concatenate. * @param otherStrings Optional additional expressions or literals (typically strings) to concatenate. - * @return A new {@code Expression} representing the concatenated string. + * @returns A new `Expression` representing the concatenated string. */ export function stringConcat( fieldName: string, @@ -5911,7 +5999,7 @@ export function stringConcat( * @param firstString The initial string expression to concatenate to. * @param secondString An expression or string literal to concatenate. * @param otherStrings Optional additional expressions or literals (typically strings) to concatenate. - * @return A new {@code Expression} representing the concatenated string. + * @returns A new `Expression` representing the concatenated string. */ export function stringConcat( firstString: Expression, @@ -5940,7 +6028,7 @@ export function stringConcat( * * @param fieldName The field name of the map field. * @param subField The key to access in the map. - * @return A new {@code Expression} representing the value associated with the given key in the map. + * @returns A new `Expression` representing the value associated with the given key in the map. */ export function mapGet(fieldName: string, subField: string): FunctionExpression; @@ -5955,7 +6043,7 @@ export function mapGet(fieldName: string, subField: string): FunctionExpression; * * @param mapExpression The expression representing the map. * @param subField The key to access in the map. - * @return A new {@code Expression} representing the value associated with the given key in the map. + * @returns A new `Expression` representing the value associated with the given key in the map. */ export function mapGet( mapExpression: Expression, @@ -5977,7 +6065,7 @@ export function mapGet( * countAll().as("totalDocument"); * ``` * - * @return A new {@code AggregateFunction} representing the 'countAll' aggregation. + * @returns A new `AggregateFunction` representing the 'countAll' aggregation. */ export function countAll(): AggregateFunction { return new AggregateFunction('count', []); @@ -5994,7 +6082,7 @@ export function countAll(): AggregateFunction { * ``` * * @param expression The expression to count. - * @return A new {@code AggregateFunction} representing the 'count' aggregation. + * @returns A new `AggregateFunction` representing the 'count' aggregation. */ export function count(expression: Expression): AggregateFunction; @@ -6008,7 +6096,7 @@ export function count(expression: Expression): AggregateFunction; * ``` * * @param fieldName The name of the field to count. - * @return A new {@code AggregateFunction} representing the 'count' aggregation. + * @returns A new `AggregateFunction` representing the 'count' aggregation. */ export function count(fieldName: string): AggregateFunction; export function count(value: Expression | string): AggregateFunction { @@ -6026,7 +6114,7 @@ export function count(value: Expression | string): AggregateFunction { * ``` * * @param expression The expression to sum up. - * @return A new {@code AggregateFunction} representing the 'sum' aggregation. + * @returns A new `AggregateFunction` representing the 'sum' aggregation. */ export function sum(expression: Expression): AggregateFunction; @@ -6041,7 +6129,7 @@ export function sum(expression: Expression): AggregateFunction; * ``` * * @param fieldName The name of the field containing numeric values to sum up. - * @return A new {@code AggregateFunction} representing the 'sum' aggregation. + * @returns A new `AggregateFunction` representing the 'sum' aggregation. */ export function sum(fieldName: string): AggregateFunction; export function sum(value: Expression | string): AggregateFunction { @@ -6059,7 +6147,7 @@ export function sum(value: Expression | string): AggregateFunction { * ``` * * @param expression The expression representing the values to average. - * @return A new {@code AggregateFunction} representing the 'average' aggregation. + * @returns A new `AggregateFunction` representing the 'average' aggregation. */ export function average(expression: Expression): AggregateFunction; @@ -6074,7 +6162,7 @@ export function average(expression: Expression): AggregateFunction; * ``` * * @param fieldName The name of the field containing numeric values to average. - * @return A new {@code AggregateFunction} representing the 'average' aggregation. + * @returns A new `AggregateFunction` representing the 'average' aggregation. */ export function average(fieldName: string): AggregateFunction; export function average(value: Expression | string): AggregateFunction { @@ -6092,7 +6180,7 @@ export function average(value: Expression | string): AggregateFunction { * ``` * * @param expression The expression to find the minimum value of. - * @return A new {@code AggregateFunction} representing the 'min' aggregation. + * @returns A new `AggregateFunction` representing the 'min' aggregation. */ export function minimum(expression: Expression): AggregateFunction; @@ -6106,7 +6194,7 @@ export function minimum(expression: Expression): AggregateFunction; * ``` * * @param fieldName The name of the field to find the minimum value of. - * @return A new {@code AggregateFunction} representing the 'min' aggregation. + * @returns A new `AggregateFunction` representing the 'min' aggregation. */ export function minimum(fieldName: string): AggregateFunction; export function minimum(value: Expression | string): AggregateFunction { @@ -6124,7 +6212,7 @@ export function minimum(value: Expression | string): AggregateFunction { * ``` * * @param expression The expression to find the maximum value of. - * @return A new {@code AggregateFunction} representing the 'max' aggregation. + * @returns A new `AggregateFunction` representing the 'max' aggregation. */ export function maximum(expression: Expression): AggregateFunction; @@ -6138,7 +6226,7 @@ export function maximum(expression: Expression): AggregateFunction; * ``` * * @param fieldName The name of the field to find the maximum value of. - * @return A new {@code AggregateFunction} representing the 'max' aggregation. + * @returns A new `AggregateFunction` representing the 'max' aggregation. */ export function maximum(fieldName: string): AggregateFunction; export function maximum(value: Expression | string): AggregateFunction { @@ -6156,7 +6244,7 @@ export function maximum(value: Expression | string): AggregateFunction { * * @param fieldName The name of the field containing the first vector. * @param vector The other vector (as an array of doubles) or {@link VectorValue} to compare against. - * @return A new {@code Expression} representing the Cosine distance between the two vectors. + * @returns A new `Expression` representing the Cosine distance between the two vectors. */ export function cosineDistance( fieldName: string, @@ -6174,7 +6262,7 @@ export function cosineDistance( * * @param fieldName The name of the field containing the first vector. * @param vectorExpression The other vector (represented as an Expression) to compare against. - * @return A new {@code Expression} representing the cosine distance between the two vectors. + * @returns A new `Expression` representing the cosine distance between the two vectors. */ export function cosineDistance( fieldName: string, @@ -6192,7 +6280,7 @@ export function cosineDistance( * * @param vectorExpression The first vector (represented as an Expression) to compare against. * @param vector The other vector (as an array of doubles or VectorValue) to compare against. - * @return A new {@code Expression} representing the cosine distance between the two vectors. + * @returns A new `Expression` representing the cosine distance between the two vectors. */ export function cosineDistance( vectorExpression: Expression, @@ -6210,7 +6298,7 @@ export function cosineDistance( * * @param vectorExpression The first vector (represented as an Expression) to compare against. * @param otherVectorExpression The other vector (represented as an Expression) to compare against. - * @return A new {@code Expression} representing the cosine distance between the two vectors. + * @returns A new `Expression` representing the cosine distance between the two vectors. */ export function cosineDistance( vectorExpression: Expression, @@ -6236,7 +6324,7 @@ export function cosineDistance( * * @param fieldName The name of the field containing the first vector. * @param vector The other vector (as an array of doubles or VectorValue) to calculate with. - * @return A new {@code Expression} representing the dot product between the two vectors. + * @returns A new `Expression` representing the dot product between the two vectors. */ export function dotProduct( fieldName: string, @@ -6254,7 +6342,7 @@ export function dotProduct( * * @param fieldName The name of the field containing the first vector. * @param vectorExpression The other vector (represented as an Expression) to calculate with. - * @return A new {@code Expression} representing the dot product between the two vectors. + * @returns A new `Expression` representing the dot product between the two vectors. */ export function dotProduct( fieldName: string, @@ -6272,7 +6360,7 @@ export function dotProduct( * * @param vectorExpression The first vector (represented as an Expression) to calculate with. * @param vector The other vector (as an array of doubles or VectorValue) to calculate with. - * @return A new {@code Expression} representing the dot product between the two vectors. + * @returns A new `Expression` representing the dot product between the two vectors. */ export function dotProduct( vectorExpression: Expression, @@ -6290,7 +6378,7 @@ export function dotProduct( * * @param vectorExpression The first vector (represented as an Expression) to calculate with. * @param otherVectorExpression The other vector (represented as an Expression) to calculate with. - * @return A new {@code Expression} representing the dot product between the two vectors. + * @returns A new `Expression` representing the dot product between the two vectors. */ export function dotProduct( vectorExpression: Expression, @@ -6316,7 +6404,7 @@ export function dotProduct( * * @param fieldName The name of the field containing the first vector. * @param vector The other vector (as an array of doubles or VectorValue) to compare against. - * @return A new {@code Expression} representing the Euclidean distance between the two vectors. + * @returns A new `Expression` representing the Euclidean distance between the two vectors. */ export function euclideanDistance( fieldName: string, @@ -6334,7 +6422,7 @@ export function euclideanDistance( * * @param fieldName The name of the field containing the first vector. * @param vectorExpression The other vector (represented as an Expression) to compare against. - * @return A new {@code Expression} representing the Euclidean distance between the two vectors. + * @returns A new `Expression` representing the Euclidean distance between the two vectors. */ export function euclideanDistance( fieldName: string, @@ -6353,7 +6441,7 @@ export function euclideanDistance( * * @param vectorExpression The first vector (represented as an Expression) to compare against. * @param vector The other vector (as an array of doubles or VectorValue) to compare against. - * @return A new {@code Expression} representing the Euclidean distance between the two vectors. + * @returns A new `Expression` representing the Euclidean distance between the two vectors. */ export function euclideanDistance( vectorExpression: Expression, @@ -6371,7 +6459,7 @@ export function euclideanDistance( * * @param vectorExpression The first vector (represented as an Expression) to compare against. * @param otherVectorExpression The other vector (represented as an Expression) to compare against. - * @return A new {@code Expression} representing the Euclidean distance between the two vectors. + * @returns A new `Expression` representing the Euclidean distance between the two vectors. */ export function euclideanDistance( vectorExpression: Expression, @@ -6396,7 +6484,7 @@ export function euclideanDistance( * ``` * * @param vectorExpression The expression representing the Firestore Vector. - * @return A new {@code Expression} representing the length of the array. + * @returns A new `Expression` representing the length of the array. */ export function vectorLength(vectorExpression: Expression): FunctionExpression; @@ -6410,7 +6498,7 @@ export function vectorLength(vectorExpression: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field representing the Firestore Vector. - * @return A new {@code Expression} representing the length of the array. + * @returns A new `Expression` representing the length of the array. */ export function vectorLength(fieldName: string): FunctionExpression; export function vectorLength(expr: Expression | string): FunctionExpression { @@ -6428,7 +6516,7 @@ export function vectorLength(expr: Expression | string): FunctionExpression { * ``` * * @param expr The expression representing the number of microseconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ export function unixMicrosToTimestamp(expr: Expression): FunctionExpression; @@ -6443,7 +6531,7 @@ export function unixMicrosToTimestamp(expr: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field representing the number of microseconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ export function unixMicrosToTimestamp(fieldName: string): FunctionExpression; export function unixMicrosToTimestamp( @@ -6462,7 +6550,7 @@ export function unixMicrosToTimestamp( * ``` * * @param expr The expression representing the timestamp. - * @return A new {@code Expression} representing the number of microseconds since epoch. + * @returns A new `Expression` representing the number of microseconds since epoch. */ export function timestampToUnixMicros(expr: Expression): FunctionExpression; @@ -6476,7 +6564,7 @@ export function timestampToUnixMicros(expr: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field representing the timestamp. - * @return A new {@code Expression} representing the number of microseconds since epoch. + * @returns A new `Expression` representing the number of microseconds since epoch. */ export function timestampToUnixMicros(fieldName: string): FunctionExpression; export function timestampToUnixMicros( @@ -6496,7 +6584,7 @@ export function timestampToUnixMicros( * ``` * * @param expr The expression representing the number of milliseconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ export function unixMillisToTimestamp(expr: Expression): FunctionExpression; @@ -6511,7 +6599,7 @@ export function unixMillisToTimestamp(expr: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field representing the number of milliseconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ export function unixMillisToTimestamp(fieldName: string): FunctionExpression; export function unixMillisToTimestamp( @@ -6531,7 +6619,7 @@ export function unixMillisToTimestamp( * ``` * * @param expr The expression representing the timestamp. - * @return A new {@code Expression} representing the number of milliseconds since epoch. + * @returns A new `Expression` representing the number of milliseconds since epoch. */ export function timestampToUnixMillis(expr: Expression): FunctionExpression; @@ -6545,7 +6633,7 @@ export function timestampToUnixMillis(expr: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field representing the timestamp. - * @return A new {@code Expression} representing the number of milliseconds since epoch. + * @returns A new `Expression` representing the number of milliseconds since epoch. */ export function timestampToUnixMillis(fieldName: string): FunctionExpression; export function timestampToUnixMillis( @@ -6566,7 +6654,7 @@ export function timestampToUnixMillis( * ``` * * @param expr The expression representing the number of seconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ export function unixSecondsToTimestamp(expr: Expression): FunctionExpression; @@ -6581,7 +6669,7 @@ export function unixSecondsToTimestamp(expr: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field representing the number of seconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new `Expression` representing the timestamp. */ export function unixSecondsToTimestamp(fieldName: string): FunctionExpression; export function unixSecondsToTimestamp( @@ -6601,7 +6689,7 @@ export function unixSecondsToTimestamp( * ``` * * @param expr The expression representing the timestamp. - * @return A new {@code Expression} representing the number of seconds since epoch. + * @returns A new `Expression` representing the number of seconds since epoch. */ export function timestampToUnixSeconds(expr: Expression): FunctionExpression; @@ -6615,7 +6703,7 @@ export function timestampToUnixSeconds(expr: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field representing the timestamp. - * @return A new {@code Expression} representing the number of seconds since epoch. + * @returns A new `Expression` representing the number of seconds since epoch. */ export function timestampToUnixSeconds(fieldName: string): FunctionExpression; export function timestampToUnixSeconds( @@ -6637,7 +6725,7 @@ export function timestampToUnixSeconds( * @param timestamp The expression representing the timestamp. * @param unit The expression evaluates to unit of time, must be one of 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'day'. * @param amount The expression evaluates to amount of the unit. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ export function timestampAdd( timestamp: Expression, @@ -6657,7 +6745,7 @@ export function timestampAdd( * @param timestamp The expression representing the timestamp. * @param unit The unit of time to add (e.g., "day", "hour"). * @param amount The amount of time to add. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ export function timestampAdd( timestamp: Expression, @@ -6677,7 +6765,7 @@ export function timestampAdd( * @param fieldName The name of the field representing the timestamp. * @param unit The unit of time to add (e.g., "day", "hour"). * @param amount The amount of time to add. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ export function timestampAdd( fieldName: string, @@ -6714,7 +6802,7 @@ export function timestampAdd( * @param timestamp The expression representing the timestamp. * @param unit The expression evaluates to unit of time, must be one of 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'day'. * @param amount The expression evaluates to amount of the unit. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ export function timestampSubtract( timestamp: Expression, @@ -6734,7 +6822,7 @@ export function timestampSubtract( * @param timestamp The expression representing the timestamp. * @param unit The unit of time to subtract (e.g., "day", "hour"). * @param amount The amount of time to subtract. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ export function timestampSubtract( timestamp: Expression, @@ -6754,7 +6842,7 @@ export function timestampSubtract( * @param fieldName The name of the field representing the timestamp. * @param unit The unit of time to subtract (e.g., "day", "hour"). * @param amount The amount of time to subtract. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new `Expression` representing the resulting timestamp. */ export function timestampSubtract( fieldName: string, @@ -6792,7 +6880,7 @@ export function timestampSubtract( * currentTimestamp() * ``` * - * @return A new Expression representing the current server timestamp. + * @returns A new Expression representing the current server timestamp. */ export function currentTimestamp(): FunctionExpression { return new FunctionExpression('current_timestamp', []); @@ -6811,7 +6899,7 @@ export function currentTimestamp(): FunctionExpression { * @param first The first filter condition. * @param second The second filter condition. * @param more Additional filter conditions to 'AND' together. - * @return A new {@code Expression} representing the logical 'AND' operation. + * @returns A new `Expression` representing the logical 'AND' operation. */ export function and( first: BooleanExpression, @@ -6834,7 +6922,7 @@ export function and( * @param first The first filter condition. * @param second The second filter condition. * @param more Additional filter conditions to 'OR' together. - * @return A new {@code Expression} representing the logical 'OR' operation. + * @returns A new `Expression` representing the logical 'OR' operation. */ export function or( first: BooleanExpression, @@ -6855,7 +6943,7 @@ export function or( * * @param base The expression to raise to the power of the exponent. * @param exponent The expression to raise the base to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ export function pow(base: Expression, exponent: Expression): FunctionExpression; @@ -6870,7 +6958,7 @@ export function pow(base: Expression, exponent: Expression): FunctionExpression; * * @param base The expression to raise to the power of the exponent. * @param exponent The constant value to raise the base to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ export function pow(base: Expression, exponent: number): FunctionExpression; @@ -6885,7 +6973,7 @@ export function pow(base: Expression, exponent: number): FunctionExpression; * * @param base The name of the field to raise to the power of the exponent. * @param exponent The expression to raise the base to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ export function pow(base: string, exponent: Expression): FunctionExpression; @@ -6900,7 +6988,7 @@ export function pow(base: string, exponent: Expression): FunctionExpression; * * @param base The name of the field to raise to the power of the exponent. * @param exponent The constant value to raise the base to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ export function pow(base: string, exponent: number): FunctionExpression; export function pow( @@ -6920,7 +7008,7 @@ export function pow( * ``` * * @param fieldName The name of the field to round. - * @return A new `Expression` representing the rounded value. + * @returns A new `Expression` representing the rounded value. */ export function round(fieldName: string): FunctionExpression; @@ -6934,7 +7022,7 @@ export function round(fieldName: string): FunctionExpression; * ``` * * @param expression An expression evaluating to a numeric value, which will be rounded. - * @return A new `Expression` representing the rounded value. + * @returns A new `Expression` representing the rounded value. */ export function round(expression: Expression): FunctionExpression; /** @@ -6948,7 +7036,7 @@ export function round(expression: Expression): FunctionExpression; * * @param fieldName The name of the field to round. * @param decimalPlaces A constant or expression specifying the rounding precision in decimal places. - * @return A new `Expr` representing the rounded value. + * @returns A new `Expr` representing the rounded value. */ export function round( fieldName: string, @@ -6966,7 +7054,7 @@ export function round( * * @param expression An expression evaluating to a numeric value, which will be rounded. * @param decimalPlaces A constant or expression specifying the rounding precision in decimal places. - * @return A new `Expr` representing the rounded value. + * @returns A new `Expr` representing the rounded value. */ export function round( expression: Expression, @@ -6993,7 +7081,7 @@ export function round( * ``` * * @param fieldName The name of the field to get the collection ID from. - * @return A new {@code Expression} representing the collectionId operation. + * @returns A new `Expression` representing the collectionId operation. */ export function collectionId(fieldName: string): FunctionExpression; @@ -7007,7 +7095,7 @@ export function collectionId(fieldName: string): FunctionExpression; * ``` * * @param expression An expression evaluating to a path, which the collection ID will be extracted from. - * @return A new {@code Expression} representing the collectionId operation. + * @returns A new `Expression` representing the collectionId operation. */ export function collectionId(expression: Expression): FunctionExpression; export function collectionId(expr: Expression | string): FunctionExpression { @@ -7027,7 +7115,7 @@ export function collectionId(expr: Expression | string): FunctionExpression { * ``` * * @param fieldName The name of the field to calculate the length of. - * @return A new `Expression` representing the length of the string, array, map, vector, or bytes. + * @returns A new `Expression` representing the length of the string, array, map, vector, or bytes. */ export function length(fieldName: string): FunctionExpression; @@ -7044,7 +7132,7 @@ export function length(fieldName: string): FunctionExpression; * ``` * * @param expression An expression evaluating to a string, array, map, vector, or bytes, which the length will be calculated for. - * @return A new `Expression` representing the length of the string, array, map, vector, or bytes. + * @returns A new `Expression` representing the length of the string, array, map, vector, or bytes. */ export function length(expression: Expression): FunctionExpression; export function length(expr: Expression | string): FunctionExpression { @@ -7061,7 +7149,7 @@ export function length(expr: Expression | string): FunctionExpression { * ``` * * @param fieldName The name of the field to compute the natural logarithm of. - * @return A new `Expression` representing the natural logarithm of the numeric value. + * @returns A new `Expression` representing the natural logarithm of the numeric value. */ export function ln(fieldName: string): FunctionExpression; @@ -7075,7 +7163,7 @@ export function ln(fieldName: string): FunctionExpression; * ``` * * @param expression An expression evaluating to a numeric value, which the natural logarithm will be computed for. - * @return A new `Expression` representing the natural logarithm of the numeric value. + * @returns A new `Expression` representing the natural logarithm of the numeric value. */ export function ln(expression: Expression): FunctionExpression; export function ln(expr: Expression | string): FunctionExpression { @@ -7092,7 +7180,7 @@ export function ln(expr: Expression | string): FunctionExpression { * ``` * * @param expression An expression evaluating to a numeric value, which the square root will be computed for. - * @return A new {@code Expression} representing the square root of the numeric value. + * @returns A new `Expression` representing the square root of the numeric value. */ export function sqrt(expression: Expression): FunctionExpression; /** @@ -7105,7 +7193,7 @@ export function sqrt(expression: Expression): FunctionExpression; * ``` * * @param fieldName The name of the field to compute the square root of. - * @return A new {@code Expression} representing the square root of the numeric value. + * @returns A new `Expression` representing the square root of the numeric value. */ export function sqrt(fieldName: string): FunctionExpression; export function sqrt(expr: Expression | string): FunctionExpression { @@ -7122,7 +7210,7 @@ export function sqrt(expr: Expression | string): FunctionExpression { * ``` * * @param stringExpression An expression evaluating to a string value, which will be reversed. - * @return A new {@code Expression} representing the reversed string. + * @returns A new `Expression` representing the reversed string. */ export function stringReverse(stringExpression: Expression): FunctionExpression; @@ -7136,7 +7224,7 @@ export function stringReverse(stringExpression: Expression): FunctionExpression; * ``` * * @param field The name of the field representing the string to reverse. - * @return A new {@code Expression} representing the reversed string. + * @returns A new `Expression` representing the reversed string. */ export function stringReverse(field: string): FunctionExpression; export function stringReverse(expr: Expression | string): FunctionExpression { @@ -7155,7 +7243,7 @@ export function stringReverse(expr: Expression | string): FunctionExpression { * @param first The first expressions to concatenate. * @param second The second literal or expression to concatenate. * @param others Additional literals or expressions to concatenate. - * @return A new `Expression` representing the concatenation. + * @returns A new `Expression` representing the concatenation. */ export function concat( first: Expression, @@ -7175,7 +7263,7 @@ export function concat( * @param fieldName The name of a field to concatenate. * @param second The second literal or expression to concatenate. * @param others Additional literal or expressions to concatenate. - * @return A new `Expression` representing the concatenation. + * @returns A new `Expression` representing the concatenation. */ export function concat( fieldName: string, @@ -7199,7 +7287,7 @@ export function concat( * Creates an expression that computes the absolute value of a numeric value. * * @param expr The expression to compute the absolute value of. - * @return A new {@code Expr} representing the absolute value of the numeric value. + * @returns A new `Expr` representing the absolute value of the numeric value. */ export function abs(expr: Expression): FunctionExpression; @@ -7208,7 +7296,7 @@ export function abs(expr: Expression): FunctionExpression; * Creates an expression that computes the absolute value of a numeric value. * * @param fieldName The field to compute the absolute value of. - * @return A new {@code Expr} representing the absolute value of the numeric value. + * @returns A new `Expr` representing the absolute value of the numeric value. */ export function abs(fieldName: string): FunctionExpression; export function abs(expr: Expression | string): FunctionExpression { @@ -7228,7 +7316,7 @@ export function abs(expr: Expression | string): FunctionExpression { * * @param ifExpr The expression to check for absence. * @param elseExpr The expression that will be evaluated and returned if [ifExpr] is absent. - * @return A new Expression representing the ifAbsent operation. + * @returns A new Expression representing the ifAbsent operation. */ export function ifAbsent(ifExpr: Expression, elseExpr: Expression): Expression; @@ -7245,7 +7333,7 @@ export function ifAbsent(ifExpr: Expression, elseExpr: Expression): Expression; * * @param ifExpr The expression to check for absence. * @param elseValue The value that will be returned if `ifExpr` evaluates to an absent value. - * @return A new [Expression] representing the ifAbsent operation. + * @returns A new [Expression] representing the ifAbsent operation. */ export function ifAbsent(ifExpr: Expression, elseValue: unknown): Expression; @@ -7263,7 +7351,7 @@ export function ifAbsent(ifExpr: Expression, elseValue: unknown): Expression; * @param ifFieldName The field to check for absence. * @param elseExpr The expression that will be evaluated and returned if `ifFieldName` is * absent. - * @return A new Expression representing the ifAbsent operation. + * @returns A new Expression representing the ifAbsent operation. */ export function ifAbsent(ifFieldName: string, elseExpr: Expression): Expression; @@ -7280,7 +7368,7 @@ export function ifAbsent(ifFieldName: string, elseExpr: Expression): Expression; * * @param ifFieldName The field to check for absence. * @param elseValue The value that will be returned if [ifFieldName] is absent. - * @return A new Expression representing the ifAbsent operation. + * @returns A new Expression representing the ifAbsent operation. */ export function ifAbsent( ifFieldName: string | Expression, @@ -7306,7 +7394,7 @@ export function ifAbsent( * * @param arrayFieldName The name of the field containing the array. * @param delimiter The string to use as a delimiter. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ export function join(arrayFieldName: string, delimiter: string): Expression; @@ -7321,7 +7409,7 @@ export function join(arrayFieldName: string, delimiter: string): Expression; * * @param arrayExpression An expression that evaluates to an array. * @param delimiterExpression The expression that evaluates to the delimiter string. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ export function join( arrayExpression: Expression, @@ -7339,7 +7427,7 @@ export function join( * * @param arrayExpression An expression that evaluates to an array. * @param delimiter The string to use as a delimiter. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ export function join( arrayExpression: Expression, @@ -7357,7 +7445,7 @@ export function join( * * @param arrayFieldName The name of the field containing the array. * @param delimiterExpression The expression that evaluates to the delimiter string. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ export function join( arrayFieldName: string, @@ -7382,7 +7470,7 @@ export function join( * ``` * * @param fieldName The name of the field to compute the base-10 logarithm of. - * @return A new `Expr` representing the base-10 logarithm of the numeric value. + * @returns A new `Expr` representing the base-10 logarithm of the numeric value. */ export function log10(fieldName: string): FunctionExpression; @@ -7396,7 +7484,7 @@ export function log10(fieldName: string): FunctionExpression; * ``` * * @param expression An expression evaluating to a numeric value, which the base-10 logarithm will be computed for. - * @return A new `Expr` representing the base-10 logarithm of the numeric value. + * @returns A new `Expr` representing the base-10 logarithm of the numeric value. */ export function log10(expression: Expression): FunctionExpression; export function log10(expr: Expression | string): FunctionExpression { @@ -7413,7 +7501,7 @@ export function log10(expr: Expression | string): FunctionExpression { * ``` * * @param fieldName The name of the field to compute the sum of. - * @return A new `Expr` representing the sum of the elements in the array. + * @returns A new `Expr` representing the sum of the elements in the array. */ export function arraySum(fieldName: string): FunctionExpression; @@ -7427,7 +7515,7 @@ export function arraySum(fieldName: string): FunctionExpression; * ``` * * @param expression An expression evaluating to a numeric array, which the sum will be computed for. - * @return A new `Expr` representing the sum of the elements in the array. + * @returns A new `Expr` representing the sum of the elements in the array. */ export function arraySum(expression: Expression): FunctionExpression; export function arraySum(expr: Expression | string): FunctionExpression { @@ -7446,7 +7534,7 @@ export function arraySum(expr: Expression | string): FunctionExpression { * @param fieldName Split the value in this field. * @param delimiter Split on this delimiter. * - * @return A new {@code Expression} representing the split function. + * @returns A new `Expression` representing the split function. */ export function split(fieldName: string, delimiter: string): FunctionExpression; @@ -7463,7 +7551,7 @@ export function split(fieldName: string, delimiter: string): FunctionExpression; * @param fieldName Split the value in this field. * @param delimiter Split on this delimiter returned by evaluating this expression. * - * @return A new {@code Expression} representing the split function. + * @returns A new `Expression` representing the split function. */ export function split( fieldName: string, @@ -7483,7 +7571,7 @@ export function split( * @param expression Split the result of this expression. * @param delimiter Split on this delimiter. * - * @return A new {@code Expression} representing the split function. + * @returns A new `Expression` representing the split function. */ export function split( expression: Expression, @@ -7503,7 +7591,7 @@ export function split( * @param expression Split the result of this expression. * @param delimiter Split on this delimiter returned by evaluating this expression. * - * @return A new {@code Expression} representing the split function. + * @returns A new `Expression` representing the split function. */ export function split( expression: Expression, @@ -7531,7 +7619,7 @@ export function split( * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ export function timestampTruncate( fieldName: string, @@ -7552,7 +7640,7 @@ export function timestampTruncate( * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ export function timestampTruncate( fieldName: string, @@ -7573,7 +7661,7 @@ export function timestampTruncate( * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ export function timestampTruncate( timestampExpression: Expression, @@ -7594,7 +7682,7 @@ export function timestampTruncate( * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ export function timestampTruncate( timestampExpression: Expression, @@ -7625,7 +7713,7 @@ export function timestampTruncate( * type('title') * ``` * - * @return A new {Expression} representing the data type. + * @returns A new {Expression} representing the data type. */ export function type(fieldName: string): FunctionExpression; /** @@ -7638,7 +7726,7 @@ export function type(fieldName: string): FunctionExpression; * type(conditional(exists('foo'), constant(1), constant(true))) * ``` * - * @return A new {Expression} representing the data type. + * @returns A new {Expression} representing the data type. */ export function type(expression: Expression): FunctionExpression; export function type( @@ -7651,7 +7739,7 @@ export function type( /** * @beta - * Creates a {@link Field} instance representing the field at the given path. + * Creates a `Field` instance representing the field at the given path. * * ```typescript * // Sort documents by the 'name' field in lowercase in ascending order @@ -7660,13 +7748,13 @@ export function type( * ``` * * @param expr The expression to create an ascending ordering for. - * @return A new `Ordering` for ascending sorting. + * @returns A new `Ordering` for ascending sorting. */ export function ascending(expr: Expression): Ordering; /** * @beta - * Creates an {@link Ordering} that sorts documents in ascending order based on a field. + * Creates an `Ordering` that sorts documents in ascending order based on a field. * * ```typescript * // Sort documents by the 'name' field in ascending order @@ -7675,7 +7763,7 @@ export function ascending(expr: Expression): Ordering; * ``` * * @param fieldName The field to create an ascending ordering for. - * @return A new `Ordering` for ascending sorting. + * @returns A new `Ordering` for ascending sorting. */ export function ascending(fieldName: string): Ordering; export function ascending(field: Expression | string): Ordering { @@ -7684,7 +7772,7 @@ export function ascending(field: Expression | string): Ordering { /** * @beta - * Creates an {@link Ordering} that sorts documents in descending order based on an expression. + * Creates an `Ordering` that sorts documents in descending order based on an expression. * * ```typescript * // Sort documents by the 'name' field in lowercase in descending order @@ -7693,13 +7781,13 @@ export function ascending(field: Expression | string): Ordering { * ``` * * @param expr The expression to create a descending ordering for. - * @return A new `Ordering` for descending sorting. + * @returns A new `Ordering` for descending sorting. */ export function descending(expr: Expression): Ordering; /** * @beta - * Creates an {@link Ordering} that sorts documents in descending order based on a field. + * Creates an `Ordering` that sorts documents in descending order based on a field. * * ```typescript * // Sort documents by the 'name' field in descending order @@ -7708,7 +7796,7 @@ export function descending(expr: Expression): Ordering; * ``` * * @param fieldName The field to create a descending ordering for. - * @return A new `Ordering` for descending sorting. + * @returns A new `Ordering` for descending sorting. */ export function descending(fieldName: string): Ordering; export function descending(field: Expression | string): Ordering { diff --git a/dev/src/pipelines/pipelines.ts b/dev/src/pipelines/pipelines.ts index e2a3af317..2844c29ca 100644 --- a/dev/src/pipelines/pipelines.ts +++ b/dev/src/pipelines/pipelines.ts @@ -108,7 +108,7 @@ import { /** * @beta - * Represents the source of a Firestore {@link Pipeline}. + * Represents the source of a Firestore `Pipeline`. */ export class PipelineSource implements firestore.Pipelines.PipelineSource { constructor(private db: Firestore) {} @@ -323,6 +323,7 @@ export class PipelineSource implements firestore.Pipelines.PipelineSource { * * Usage Examples: * + * @example * ```typescript * const db: Firestore; // Assumes a valid firestore instance. * @@ -366,14 +367,14 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * stages or constants. You can use this to create new fields or overwrite existing ones (if there * is name overlaps). * - * The added fields are defined using {@link Selectable}s, which can be: + * The added fields are defined using `Selectable`s, which can be: * - * - {@link Field}: References an existing document field. - * - {@link Expression}: Either a literal value (see {@link Constant}) or a computed value - * (see {@FunctionExpression}) with an assigned alias using {@link Expression#as}. + * - `Field`: References an existing document field. + * - `Expression`: Either a literal value (see `constant(value)`) or a computed value + * (see `Expression`) with an assigned alias using `Expression.as('alias')`. * - * Example: * + * @example * ```typescript * firestore.pipeline().collection("books") * .addFields( @@ -382,9 +383,9 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ); * ``` * - * @param field The first field to add to the documents, specified as a {@link Selectable}. - * @param additionalFields Optional additional fields to add to the documents, specified as {@link Selectable}s. - * @return A new Pipeline object with this stage appended to the stage list. + * @param field The first field to add to the documents, specified as a `Selectable`. + * @param additionalFields Optional additional fields to add to the documents, specified as `Selectable`s. + * @returns A new Pipeline object with this stage appended to the stage list. */ addFields( field: firestore.Pipelines.Selectable, @@ -398,14 +399,14 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * stages or constants. You can use this to create new fields or overwrite existing ones (if there * is name overlaps). * - * The added fields are defined using {@link Selectable}s, which can be: + * The added fields are defined using `Selectable`s, which can be: * - * - {@link Field}: References an existing document field. - * - {@link Expression}: Either a literal value (see {@link Constant}) or a computed value - * (see {@FunctionExpression}) with an assigned alias using {@link Expression#as}. + * - `Field`: References an existing document field. + * - `Expression`: Either a literal value (see `constant(value)`) or a computed value + * (see `Expression`) with an assigned alias using `Expression.as('alias')`}. * - * Example: * + * @example * ```typescript * firestore.pipeline().collection("books") * .addFields( @@ -415,7 +416,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ addFields(options: firestore.Pipelines.AddFieldsStageOptions): Pipeline; addFields( @@ -445,8 +446,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * @beta * Remove fields from outputs of previous stages. * - * Example: * + * @example * ```typescript * firestore.pipeline().collection('books') * // removes field 'rating' and 'cost' from the previous stage outputs. @@ -458,7 +459,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * * @param fieldValue The first field to remove. * @param additionalFields Optional additional fields to remove. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ removeFields( fieldValue: firestore.Pipelines.Field | string, @@ -468,8 +469,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * @beta * Remove fields from outputs of previous stages. * - * Example: * + * @example * ```typescript * firestore.pipeline().collection('books') * // removes field 'rating' and 'cost' from the previous stage outputs. @@ -480,7 +481,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ removeFields(options: firestore.Pipelines.RemoveFieldsStageOptions): Pipeline; removeFields( @@ -516,12 +517,12 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * @beta * Selects or creates a set of fields from the outputs of previous stages. * - *

The selected fields are defined using {@link Selectable} expressions, which can be: + *

The selected fields are defined using `Selectable` expressions, which can be: * *

    - *
  • {@code string}: Name of an existing field
    • - *
  • {@link Field}: References an existing field.
    • - *
  • {@link Function}: Represents the result of a function with an assigned alias name using + *
  • `string`: Name of an existing field
    • + *
  • `Field`: References an existing field.
    • + *
  • `AliasedExpression`: Represents the result of a function with an assigned alias name using * {@link Expression#as}
    • *
* @@ -529,8 +530,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Pipeline#addFields} instead if only additions are * desired. * - *

Example: * + * @example * ```typescript * db.pipeline().collection("books") * .select( @@ -540,11 +541,11 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ); * ``` * - * @param selection The first field to include in the output documents, specified as {@link - * Selectable} expression or string value representing the field name. - * @param additionalSelections Optional additional fields to include in the output documents, specified as {@link - * Selectable} expressions or {@code string} values representing field names. - * @return A new Pipeline object with this stage appended to the stage list. + * @param selection The first field to include in the output documents, specified as + * `Selectable` expression or string value representing the field name. + * @param additionalSelections Optional additional fields to include in the output documents, specified as + * `Selectable` expressions or `string` values representing field names. + * @returns A new Pipeline object with this stage appended to the stage list. */ select( selection: firestore.Pipelines.Selectable | string, @@ -554,12 +555,12 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * @beta * Selects or creates a set of fields from the outputs of previous stages. * - *

The selected fields are defined using {@link Selectable} expressions, which can be: + *

The selected fields are defined using `Selectable` expressions, which can be: * *

    - *
  • {@code string}: Name of an existing field
    • - *
  • {@link Field}: References an existing field.
    • - *
  • {@link Function}: Represents the result of a function with an assigned alias name using + *
  • `string`: Name of an existing field
    • + *
  • `Field`: References an existing field.
    • + *
  • `AliasedExpression`: Represents the result of a function with an assigned alias name using * {@link Expression#as}
    • *
* @@ -567,8 +568,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Pipeline#addFields} instead if only additions are * desired. * - *

Example: * + * @example * ```typescript * db.pipeline().collection("books") * .select( @@ -579,7 +580,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ select(options: firestore.Pipelines.SelectStageOptions): Pipeline; select( @@ -612,12 +613,11 @@ export class Pipeline implements firestore.Pipelines.Pipeline { /** * @beta - * Filters the documents from previous stages to only include those matching the specified {@link - * BooleanExpression}. + * Filters the documents from previous stages to only include those matching the specified `BooleanExpression`. * *

This stage allows you to apply conditions to the data, similar to a "WHERE" clause in SQL. - * You can filter documents based on their field values, using implementations of {@link - * BooleanExpression}, typically including but not limited to: + * You can filter documents based on their field values, using implementations of `BooleanExpression`, typically + * including but not limited to: * *

    *
  • field comparators: {@link Function#equal}, {@link Function#lessThan} (less than), {@link @@ -627,8 +627,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Function#arrayContains}, etc.
    • *
* - *

Example: * + * @example * ```typescript * firestore.pipeline().collection("books") * .where( @@ -639,18 +639,17 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ); * ``` * - * @param condition The {@link BooleanExpression} to apply. - * @return A new Pipeline object with this stage appended to the stage list. + * @param condition The `BooleanExpression` to apply. + * @returns A new Pipeline object with this stage appended to the stage list. */ where(condition: firestore.Pipelines.BooleanExpression): Pipeline; /** * @beta - * Filters the documents from previous stages to only include those matching the specified {@link - * BooleanExpression}. + * Filters the documents from previous stages to only include those matching the specified `BooleanExpression`. * *

This stage allows you to apply conditions to the data, similar to a "WHERE" clause in SQL. - * You can filter documents based on their field values, using implementations of {@link - * BooleanExpression}, typically including but not limited to: + * You can filter documents based on their field values, using implementations of `BooleanExpression`, typically + * including but not limited to: * *

    *
  • field comparators: {@link Function#equal}, {@link Function#lessThan} (less than), {@link @@ -660,8 +659,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Function#arrayContains}, etc.
    • *
* - *

Example: * + * @example * ```typescript * firestore.pipeline().collection("books") * .where( @@ -673,7 +672,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ where(options: firestore.Pipelines.WhereStageOptions): Pipeline; where( @@ -705,11 +704,11 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Skips the first `offset` number of documents from the results of previous stages. * *

This stage is useful for implementing pagination in your pipelines, allowing you to retrieve - * results in chunks. It is typically used in conjunction with {@link #limit} to control the + * results in chunks. It is typically used in conjunction with to control the * size of each page. * - *

Example: * + * @example * ```typescript * // Retrieve the second page of 20 results * firestore.pipeline().collection('books') @@ -719,7 +718,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param offset The number of documents to skip. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ offset(offset: number): Pipeline; /** @@ -727,11 +726,11 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Skips the first `offset` number of documents from the results of previous stages. * *

This stage is useful for implementing pagination in your pipelines, allowing you to retrieve - * results in chunks. It is typically used in conjunction with {@link #limit} to control the + * results in chunks. It is typically used in conjunction with `limit` to control the * size of each page. * - *

Example: * + * @example * ```typescript * // Retrieve the second page of 20 results * firestore.pipeline().collection('books') @@ -741,7 +740,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ offset(options: firestore.Pipelines.OffsetStageOptions): Pipeline; offset( @@ -768,14 +767,14 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * a potentially large result set. It's often used for: * *

    - *
  • **Pagination:** In combination with {@link #offset} to retrieve specific pages of + *
  • **Pagination:** In combination with `offset` to retrieve specific pages of * results.
    • *
  • **Limiting Data Retrieval:** To prevent excessive data transfer and improve performance, * especially when dealing with large collections.
    • *
* - *

Example: * + * @example * ```typescript * // Limit the results to the top 10 highest-rated books * firestore.pipeline().collection('books') @@ -784,7 +783,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param limit The maximum number of documents to return. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ limit(limit: number): Pipeline; /** @@ -795,14 +794,14 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * a potentially large result set. It's often used for: * *

    - *
  • **Pagination:** In combination with {@link #offset} to retrieve specific pages of + *
  • **Pagination:** In combination with `offset` to retrieve specific pages of * results.
    • *
  • **Limiting Data Retrieval:** To prevent excessive data transfer and improve performance, * especially when dealing with large collections.
    • *
* - *

Example: * + * @example * ```typescript * // Limit the results to the top 10 highest-rated books * firestore.pipeline().collection('books') @@ -811,7 +810,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ limit(options: firestore.Pipelines.LimitStageOptions): Pipeline; limit( @@ -835,17 +834,17 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Returns a set of distinct values from the inputs to this stage. * * This stage runs through the results from previous stages to include only results with - * unique combinations of {@link Expression} values ({@link Field}, {@link Function}, etc). + * unique combinations of `Expression` values. * - * The parameters to this stage are defined using {@link Selectable} expressions or strings: + * The parameters to this stage are defined using `Selectable` expressions or strings: * - * - {@code string}: Name of an existing field - * - {@link Field}: References an existing document field. - * - {@link AliasedExpression}: Represents the result of a function with an assigned alias name + * - `string`: Name of an existing field + * - `Field`: References an existing document field. + * - `AliasedExpression`: Represents the result of a function with an assigned alias name * using {@link Expression#as}. * - * Example: * + * @example * ```typescript * // Get a list of unique author names in uppercase and genre combinations. * firestore.pipeline().collection("books") @@ -853,11 +852,11 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * .select("authorName"); * ``` * - * @param group The {@link Selectable} expression or field name to consider when determining + * @param group The `Selectable` expression or field name to consider when determining * distinct value combinations. - * @param additionalGroups Optional additional {@link Selectable} expressions to consider when determining distinct + * @param additionalGroups Optional additional `Selectable` expressions to consider when determining distinct * value combinations or strings representing field names. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ distinct( group: string | firestore.Pipelines.Selectable, @@ -868,17 +867,17 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Returns a set of distinct values from the inputs to this stage. * * This stage runs through the results from previous stages to include only results with - * unique combinations of {@link Expression} values ({@link Field}, {@link Function}, etc). + * unique combinations of `Expression` values. * - * The parameters to this stage are defined using {@link Selectable} expressions or strings: + * The parameters to this stage are defined using `Selectable` expressions or strings: * - * - {@code string}: Name of an existing field - * - {@link Field}: References an existing document field. - * - {@link AliasedExpression}: Represents the result of a function with an assigned alias name + * - `string`: Name of an existing field + * - `Field`: References an existing document field. + * - `AliasedExpression`: Represents the result of a function with an assigned alias name * using {@link Expression#as}. * - * Example: * + * @example * ```typescript * // Get a list of unique author names in uppercase and genre combinations. * firestore.pipeline().collection("books") @@ -887,7 +886,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ distinct(options: firestore.Pipelines.DistinctStageOptions): Pipeline; distinct( @@ -922,11 +921,11 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Performs aggregation operations on the documents from previous stages. * *

This stage allows you to calculate aggregate values over a set of documents. You define the - * aggregations to perform using {@link AliasedAggregate} expressions which are typically results of - * calling {@link Expression#as} on {@link AggregateFunction} instances. + * aggregations to perform using `AliasedAggregate` expressions which are typically results of + * calling {@link Expression#as} on `AggregateFunction` instances. * - *

Example: * + * @example * ```typescript * // Calculate the average rating and the total number of books * firestore.pipeline().collection("books") @@ -936,11 +935,11 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ); * ``` * - * @param accumulator The first {@link AliasedAggregate}, wrapping an {@link AggregateFunction} + * @param accumulator The first `AliasedAggregate`, wrapping an `AggregateFunction` * and providing a name for the accumulated results. - * @param additionalAccumulators Optional additional {@link AliasedAggregate}, each wrapping an {@link AggregateFunction} + * @param additionalAccumulators Optional additional `AliasedAggregate`, each wrapping an `AggregateFunction` * and providing a name for the accumulated results. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ aggregate( accumulator: firestore.Pipelines.AliasedAggregate, @@ -959,13 +958,13 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * If no grouping fields are provided, a single group containing all documents is used. Not * specifying groups is the same as putting the entire inputs into one group. *

  • **Accumulators:** One or more accumulation operations to perform within each group. These - * are defined using {@link AliasedAggregate} expressions, which are typically created by - * calling {@link Expression#as} on {@link AggregateFunction} instances. Each aggregation + * are defined using `AliasedAggregate` expressions, which are typically created by + * calling {@link Expression#as} on `AggregateFunction` instances. Each aggregation * calculates a value (e.g., sum, average, count) based on the documents within its group.
    • * * - *

    Example: * + * @example * ```typescript * // Calculate the average rating for each genre. * firestore.pipeline().collection("books") @@ -976,7 +975,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage + * @returns A new `Pipeline` object with this stage appended to the stage * list. */ aggregate(options: firestore.Pipelines.AggregateStageOptions): Pipeline; @@ -1014,8 +1013,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * K-nearest documents based on the specified query `vectorValue` and `distanceMeasure`. The * returned documents will be sorted in order from nearest to furthest from the query `vectorValue`. * - *

    Example: * + * @example * ```typescript * // Find the 10 most similar books based on the book description. * const bookDescription = "Lorem ipsum..."; @@ -1032,7 +1031,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ findNearest(options: firestore.Pipelines.FindNearestStageOptions): Pipeline { const field = toField(options.field); @@ -1062,8 +1061,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { *

    This stage allows you to emit a map value as a document. Each key of the map becomes a field * on the document that contains the corresponding value. * - *

    Example: * + * @example * ```typescript * // Input. * // { @@ -1084,8 +1083,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * // } * ``` * - * @param fieldName The {@link Field} field containing the nested map. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @param fieldName The `Field` field containing the nested map. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ replaceWith(fieldName: string): Pipeline; /** @@ -1095,8 +1094,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { *

    This stage allows you to emit a map value as a document. Each key of the map becomes a field * on the document that contains the corresponding value. * - *

    Example: * + * @example * ```typescript * // Input. * // { @@ -1122,8 +1121,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * // } * ``` * - * @param expr An {@link Expression} that when returned evaluates to a map. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @param expr An `Expression` that when returned evaluates to a map. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ replaceWith(expr: firestore.Pipelines.Expression): Pipeline; /** @@ -1133,8 +1132,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { *

    This stage allows you to emit a map value as a document. Each key of the map becomes a field * on the document that contains the corresponding value. * - *

    Example: * + * @example * ```typescript * // Input. * // { @@ -1161,7 +1160,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ replaceWith(options: firestore.Pipelines.ReplaceWithStageOptions): Pipeline; replaceWith( @@ -1196,6 +1195,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * *

    Examples: * + * @example * ```typescript * // Sample 25 books, if available. * firestore.pipeline().collection('books') @@ -1203,7 +1203,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param documents The number of documents to sample. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ sample(documents: number): Pipeline; @@ -1212,7 +1212,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Performs a pseudo-random sampling of the documents from the previous stage. * *

    This stage will filter documents pseudo-randomly. The 'options' parameter specifies how - * sampling will be performed. See {@code SampleOptions} for more information. + * sampling will be performed. See `SampleOptions` for more information. * *

    Examples: * @@ -1225,7 +1225,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * .sample({ percentage: 0.5 }); * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ sample(options: firestore.Pipelines.SampleStageOptions): Pipeline; sample( @@ -1260,19 +1260,19 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Performs union of all documents from two pipelines, including duplicates. * *

    This stage will pass through documents from previous stage, and also pass through documents - * from previous stage of the `other` {@code Pipeline} given in parameter. The order of documents + * from previous stage of the `other` `Pipeline` given in parameter. The order of documents * emitted from this stage is undefined. * - *

    Example: * + * @example * ```typescript * // Emit documents from books collection and magazines collection. * firestore.pipeline().collection('books') * .union(firestore.pipeline().collection('magazines')); * ``` * - * @param other The other {@code Pipeline} that is part of union. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @param other The other `Pipeline` that is part of union. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ union(other: firestore.Pipelines.Pipeline): Pipeline; /** @@ -1280,11 +1280,11 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Performs union of all documents from two pipelines, including duplicates. * *

    This stage will pass through documents from previous stage, and also pass through documents - * from previous stage of the `other` {@code Pipeline} given in parameter. The order of documents + * from previous stage of the `other` `Pipeline` given in parameter. The order of documents * emitted from this stage is undefined. * - *

    Example: * + * @example * ```typescript * // Emit documents from books collection and magazines collection. * firestore.pipeline().collection('books') @@ -1292,7 +1292,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ union(options: firestore.Pipelines.UnionStageOptions): Pipeline; union( @@ -1329,8 +1329,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * * No documents are emitted when `selectable` evaluates to an empty array. * - * Example: * + * @example * ```typescript * // Input: * // { "title": "The Hitchhiker's Guide to the Galaxy", "tags": [ "comedy", "space", "adventure" ], ... } @@ -1347,7 +1347,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * * @param selectable A selectable expression defining the field to unnest and the alias to use for each un-nested element in the output documents. * @param indexField An optional string value specifying the field path to write the offset (starting at zero) into the array the un-nested element is from - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ unnest( selectable: firestore.Pipelines.Selectable, @@ -1366,8 +1366,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * * No documents are emitted when `selectable` evaluates to an empty array. * - * Example: * + * @example * ```typescript * // Input: * // { "title": "The Hitchhiker's Guide to the Galaxy", "tags": [ "comedy", "space", "adventure" ], ... } @@ -1383,7 +1383,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ unnest(options: firestore.Pipelines.UnnestStageOptions): Pipeline; unnest( @@ -1422,16 +1422,16 @@ export class Pipeline implements firestore.Pipelines.Pipeline { /** * @beta - * Sorts the documents from previous stages based on one or more {@link Ordering} criteria. + * Sorts the documents from previous stages based on one or more `Ordering` criteria. * - *

    This stage allows you to order the results of your pipeline. You can specify multiple {@link - * Ordering} instances to sort by multiple fields in ascending or descending order. If documents + *

    This stage allows you to order the results of your pipeline. You can specify multiple + * `Ordering` instances to sort by multiple fields in ascending or descending order. If documents * have the same value for a field used for sorting, the next specified ordering will be used. If * all orderings result in equal comparison, the documents are considered equal and the order is * unspecified. * - *

    Example: * + * @example * ```typescript * // Sort books by rating in descending order, and then by title in ascending order for books * // with the same rating @@ -1442,9 +1442,9 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ); * ``` * - * @param ordering The first {@link Ordering} instance specifying the sorting criteria. - * @param additionalOrderings Optional additional {@link Ordering} instances specifying the additional sorting criteria. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @param ordering The first `Ordering` instance specifying the sorting criteria. + * @param additionalOrderings Optional additional `Ordering` instances specifying the additional sorting criteria. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ sort( ordering: firestore.Pipelines.Ordering, @@ -1452,16 +1452,16 @@ export class Pipeline implements firestore.Pipelines.Pipeline { ): Pipeline; /** * @beta - * Sorts the documents from previous stages based on one or more {@link Ordering} criteria. + * Sorts the documents from previous stages based on one or more `Ordering` criteria. * - *

    This stage allows you to order the results of your pipeline. You can specify multiple {@link - * Ordering} instances to sort by multiple fields in ascending or descending order. If documents + *

    This stage allows you to order the results of your pipeline. You can specify multiple + * `Ordering` instances to sort by multiple fields in ascending or descending order. If documents * have the same value for a field used for sorting, the next specified ordering will be used. If * all orderings result in equal comparison, the documents are considered equal and the order is * unspecified. * - *

    Example: * + * @example * ```typescript * // Sort books by rating in descending order, and then by title in ascending order for books * // with the same rating @@ -1473,7 +1473,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ sort(options: firestore.Pipelines.SortStageOptions): Pipeline; sort( @@ -1508,8 +1508,10 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * stages. Each raw stage is defined by a unique `name` and a set of `params` that control its * behavior. * - *

    Example (Assuming there is no 'where' stage available in SDK): + * @example + * Assuming there is no 'where' stage available in SDK: * + * @example * ```typescript * // Assume we don't have a built-in 'where' stage * firestore.pipeline().collection('books') @@ -1520,7 +1522,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * @param name - The unique name of the raw stage to add. * @param params - A list of parameters to configure the raw stage's behavior. * @param options - An object of key value pairs that specifies optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ rawStage( name: string, @@ -1558,22 +1560,22 @@ export class Pipeline implements firestore.Pipelines.Pipeline { *

    The returned Promise can be used to track the progress of the pipeline execution * and retrieve the results (or handle any errors) asynchronously. * - *

    The pipeline results are returned in a {@link PipelineSnapshot} object, which contains a list of - * {@link PipelineResult} objects. Each {@link PipelineResult} typically represents a single key/value map that + *

    The pipeline results are returned in a `PipelineSnapshot` object, which contains a list of + * `PipelineResult` objects. Each `PipelineResult` typically represents a single key/value map that * has passed through all the stages of the pipeline, however this might differ depending on the stages involved * in the pipeline. For example: * *

      - *
    • If there are no stages or only transformation stages, each {@link PipelineResult} + *
    • If there are no stages or only transformation stages, each `PipelineResult` * represents a single document.
      • - *
    • If there is an aggregation, only a single {@link PipelineResult} is returned, + *
    • If there is an aggregation, only a single `PipelineResult` is returned, * representing the aggregated results over the entire dataset .
      • - *
    • If there is an aggregation stage with grouping, each {@link PipelineResult} represents a + *
    • If there is an aggregation stage with grouping, each `PipelineResult` represents a * distinct group and its associated aggregated values.
      • *
    * - *

    Example: * + * @example * ```typescript * const futureResults = await firestore.pipeline().collection('books') * .where(greaterThan(field('rating'), 4.5)) @@ -1582,7 +1584,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * ``` * * @param pipelineExecuteOptions - Optionally specify pipeline execution behavior. - * @return A Promise representing the asynchronous pipeline execution. + * @returns A Promise representing the asynchronous pipeline execution. */ execute( pipelineExecuteOptions?: firestore.Pipelines.PipelineExecuteOptions, @@ -1623,7 +1625,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { /** * @beta - * Executes this pipeline and streams the results as {@link PipelineResult}s. + * Executes this pipeline and streams the results as `PipelineResult`s. * * @returns {Stream.} A stream of * PipelineResult. @@ -1657,7 +1659,7 @@ export class Pipeline implements firestore.Pipelines.Pipeline { * Validates user data for each expression in the expressionMap. * @param name Name of the calling function. Used for error messages when invalid user data is encountered. * @param val - * @return the expressionMap argument. + * @returns the expressionMap argument. * @private */ _validateUserData< @@ -1789,7 +1791,7 @@ export class ExplainStats implements firestore.Pipelines.ExplainStats { * @beta * Represents the results of a Firestore pipeline execution. * - * A `PipelineSnapshot` contains zero or more {@link PipelineResult} objects + * A `PipelineSnapshot` contains zero or more `PipelineResult` objects * representing the documents returned by a pipeline query. It provides methods * to iterate over the documents and access metadata about the query results. * @@ -1870,7 +1872,7 @@ export class PipelineSnapshot implements firestore.Pipelines.PipelineSnapshot { /** * @beta * A PipelineResult contains data read from a Firestore Pipeline. The data can be extracted with the - * {@link #data()} or {@link #get(String)} methods. + * `data()` or `get(String)` methods. * *

    If the PipelineResult represents a non-document result, `ref` will return a undefined * value. @@ -2057,7 +2059,7 @@ export class PipelineResult implements firestore.Pipelines.PipelineResult { * equal to the provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `PipelineResult` is equal to the provided + * @returns {boolean} true if this `PipelineResult` is equal to the provided * value. */ isEqual(other: PipelineResult): boolean { diff --git a/dev/src/pool.ts b/dev/src/pool.ts index aec8740e0..5bb455017 100644 --- a/dev/src/pool.ts +++ b/dev/src/pool.ts @@ -289,7 +289,7 @@ export class ClientPool { /** * The number of currently registered clients. * - * @return Number of currently registered clients. + * @returns Number of currently registered clients. * @private * @internal */ @@ -301,7 +301,7 @@ export class ClientPool { /** * The number of currently active operations. * - * @return Number of currently active operations. + * @returns Number of currently active operations. * @private * @internal */ @@ -317,7 +317,7 @@ export class ClientPool { /** * The currently active clients. * - * @return The currently active clients. + * @returns The currently active clients. * @private * @internal */ @@ -337,7 +337,7 @@ export class ClientPool { * @param requestTag A unique client-assigned identifier for this operation. * @param op A callback function that returns a Promise. The client T will * be returned to the pool when callback finishes. - * @return A Promise that resolves with the result of `op`. + * @returns A Promise that resolves with the result of `op`. * @private * @internal */ diff --git a/dev/src/query-partition.ts b/dev/src/query-partition.ts index 626642c65..46f254864 100644 --- a/dev/src/query-partition.ts +++ b/dev/src/query-partition.ts @@ -80,7 +80,7 @@ export class QueryPartition< * * ``` * @type {Array<*>} - * @return {Array<*>} A cursor value that can be used with {@link + * @returns {Array<*>} A cursor value that can be used with {@link * Query#startAt} or `undefined` if this is the first partition. */ get startAt(): unknown[] | undefined { @@ -116,7 +116,7 @@ export class QueryPartition< * * ``` * @type {Array<*>} - * @return {Array<*>} A cursor value that can be used with {@link + * @returns {Array<*>} A cursor value that can be used with {@link * Query#endBefore} or `undefined` if this is the last partition. */ get endBefore(): unknown[] | undefined { @@ -142,7 +142,7 @@ export class QueryPartition< * } * * ``` - * @return {Query} A query partitioned by a {@link Query#startAt} and + * @returns {Query} A query partitioned by a {@link Query#startAt} and * {@link Query#endBefore} cursor. */ toQuery(): Query { diff --git a/dev/src/recursive-delete.ts b/dev/src/recursive-delete.ts index 1e5b04f8e..938c37b53 100644 --- a/dev/src/recursive-delete.ts +++ b/dev/src/recursive-delete.ts @@ -223,7 +223,7 @@ export class RecursiveDelete { * @param ref The reference to fetch all descendants for. * @private * @internal - * @return {Stream} Stream of descendant documents. + * @returns {Stream} Stream of descendant documents. */ private getAllDescendants( ref: CollectionReference | DocumentReference, diff --git a/dev/src/reference/aggregate-query-snapshot.ts b/dev/src/reference/aggregate-query-snapshot.ts index 41da5b8fb..b0d4a06fc 100644 --- a/dev/src/reference/aggregate-query-snapshot.ts +++ b/dev/src/reference/aggregate-query-snapshot.ts @@ -85,7 +85,7 @@ export class AggregateQuerySnapshot< * `AggregateQuery.isEqual()`. * * @param other The object to compare to this object for equality. - * @return `true` if this object is "equal" to the given object, as + * @returns `true` if this object is "equal" to the given object, as * defined above, or `false` otherwise. */ isEqual( diff --git a/dev/src/reference/aggregate-query.ts b/dev/src/reference/aggregate-query.ts index 6c2e19b32..f4934c44d 100644 --- a/dev/src/reference/aggregate-query.ts +++ b/dev/src/reference/aggregate-query.ts @@ -82,7 +82,7 @@ export class AggregateQuery< /** * Executes this query. * - * @return A promise that will be resolved with the results of the query. + * @returns A promise that will be resolved with the results of the query. */ async get(): Promise< AggregateQuerySnapshot @@ -392,7 +392,7 @@ export class AggregateQuery< * using `Query.isEqual()`. * * @param other The object to compare to this object for equality. - * @return `true` if this object is "equal" to the given object, as + * @returns `true` if this object is "equal" to the given object, as * defined above, or `false` otherwise. */ isEqual( @@ -419,7 +419,7 @@ export class AggregateQuery< * resolved with the planner information, statistics from the query * execution (if any), and the query results (if any). * - * @return A Promise that will be resolved with the planner information, + * @returns A Promise that will be resolved with the planner information, * statistics from the query execution (if any), and the query results (if any). */ async explain( diff --git a/dev/src/reference/collection-reference.ts b/dev/src/reference/collection-reference.ts index 3d8958fe5..0cdacee32 100644 --- a/dev/src/reference/collection-reference.ts +++ b/dev/src/reference/collection-reference.ts @@ -145,7 +145,7 @@ export class CollectionReference< * document reference (e.g. via `.get()` or `.onSnapshot()`) will return a * `DocumentSnapshot` whose `.exists` property is false. * - * @return {Promise} The list of documents in this + * @returns {Promise} The list of documents in this * collection. * * @example @@ -291,7 +291,7 @@ export class CollectionReference< * Returns true if this `CollectionReference` is equal to the provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `CollectionReference` is equal to the + * @returns {boolean} true if this `CollectionReference` is equal to the * provided value. */ isEqual( @@ -364,7 +364,7 @@ export class CollectionReference< * ``` * @param {FirestoreDataConverter | null} converter Converts objects to and * from Firestore. Passing in `null` removes the current converter. - * @return A CollectionReference that uses the provided converter. + * @returns A CollectionReference that uses the provided converter. */ withConverter< NewAppModelType, diff --git a/dev/src/reference/document-reference.ts b/dev/src/reference/document-reference.ts index 593f60a01..da3f518e9 100644 --- a/dev/src/reference/document-reference.ts +++ b/dev/src/reference/document-reference.ts @@ -540,7 +540,7 @@ export class DocumentReference< * Returns true if this `DocumentReference` is equal to the provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `DocumentReference` is equal to the provided + * @returns {boolean} true if this `DocumentReference` is equal to the provided * value. */ isEqual( @@ -623,7 +623,7 @@ export class DocumentReference< * ``` * @param {FirestoreDataConverter | null} converter Converts objects to and * from Firestore. Passing in `null` removes the current converter. - * @return A DocumentReference that uses the provided converter. + * @returns A DocumentReference that uses the provided converter. */ withConverter< NewAppModelType, diff --git a/dev/src/reference/helpers.ts b/dev/src/reference/helpers.ts index 8afb843e5..1ed3c6d33 100644 --- a/dev/src/reference/helpers.ts +++ b/dev/src/reference/helpers.ts @@ -28,7 +28,7 @@ import {comparisonOperators, directionOperators} from './constants'; * @param arg The argument name or argument index (for varargs methods). * @param op Order direction to validate. * @throws when the direction is invalid - * @return a validated input value, which may be different from the provided + * @returns a validated input value, which may be different from the provided * value. */ export function validateQueryOrder( @@ -50,7 +50,7 @@ export function validateQueryOrder( * @param op Field comparison operator to validate. * @param fieldValue Value that is used in the filter. * @throws when the comparison operation is invalid - * @return a validated input value, which may be different from the provided + * @returns a validated input value, which may be different from the provided * value. */ export function validateQueryOperator( @@ -92,7 +92,7 @@ export function validateQueryOperator( * @internal * @param arg The argument name or argument index (for varargs methods). * @param value The argument to validate. - * @return the DocumentReference if valid + * @returns the DocumentReference if valid */ export function validateDocumentReference< AppModelType, diff --git a/dev/src/reference/query-snapshot.ts b/dev/src/reference/query-snapshot.ts index 212ee7f4a..6316bba24 100644 --- a/dev/src/reference/query-snapshot.ts +++ b/dev/src/reference/query-snapshot.ts @@ -194,7 +194,7 @@ export class QuerySnapshot< * this is the first snapshot, all documents will be in the list as added * changes. * - * @return {Array.} + * @returns {Array.} * * @example * ``` @@ -256,7 +256,7 @@ export class QuerySnapshot< * provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `QuerySnapshot` is equal to the provided + * @returns {boolean} true if this `QuerySnapshot` is equal to the provided * value. */ isEqual(other: firestore.QuerySnapshot): boolean { diff --git a/dev/src/reference/query.ts b/dev/src/reference/query.ts index 3f2f84238..49e8e9935 100644 --- a/dev/src/reference/query.ts +++ b/dev/src/reference/query.ts @@ -146,7 +146,7 @@ export class Query< * @param documentSnapshot The document to extract the fields from. * @param fieldOrders The field order that defines what fields we should * extract. - * @return {Array.<*>} The field values to use. + * @returns {Array.<*>} The field values to use. */ static _extractFieldValues( documentSnapshot: DocumentSnapshot, @@ -498,7 +498,7 @@ export class Query< * Results for limitToLast queries cannot be streamed via the `stream()` API. * * @param limit The maximum number of items to return. - * @return The created Query. + * @returns The created Query. * * @example * ``` @@ -558,7 +558,7 @@ export class Query< * query can count the documents in cases where the result set is * prohibitively large to download entirely (thousands of documents). * - * @return a query that counts the documents in the result set of this + * @returns a query that counts the documents in the result set of this * query. The count can be retrieved from `snapshot.data().count`, where * `snapshot` is the `AggregateQuerySnapshot` resulting from running the * returned query. @@ -637,7 +637,7 @@ export class Query< * be a positive integer with a maximum value of 1000. `distanceMeasure` specifies what type of distance is calculated * when performing the query. * - * @deprecated Use the new {@link findNearest} implementation + * @deprecated Use the new {@link Query.(findNearest:VectorQueryOptions)} implementation * accepting a single `options` param. */ findNearest( @@ -875,7 +875,7 @@ export class Query< * Returns true if this `Query` is equal to the provided value. * * @param {*} other The value to compare against. - * @return {boolean} true if this `Query` is equal to the provided value. + * @returns {boolean} true if this `Query` is equal to the provided value. */ isEqual(other: firestore.Query): boolean { if (this === other) { @@ -890,7 +890,7 @@ export class Query< /** * Returns the sorted array of inequality filter fields used in this query. * - * @return An array of inequality filter fields sorted lexicographically by FieldPath. + * @returns An array of inequality filter fields sorted lexicographically by FieldPath. */ private getInequalityFilterFields(): FieldPath[] { const inequalityFields: FieldPath[] = []; @@ -1034,7 +1034,7 @@ export class Query< * * @param val The value to validate. * @throws If the value cannot be used for this query. - * @return If valid, returns a DocumentReference that can be used with the + * @returns If valid, returns a DocumentReference that can be used with the * query. * @private * @internal @@ -1305,7 +1305,7 @@ export class Query< * resolved with the planner information, statistics from the query execution (if any), * and the query results (if any). * - * @return A Promise that will be resolved with the planner information, statistics + * @returns A Promise that will be resolved with the planner information, statistics * from the query execution (if any), and the query results (if any). */ async explain( @@ -1798,7 +1798,7 @@ export class Query< * ``` * @param {FirestoreDataConverter | null} converter Converts objects to and * from Firestore. Passing in `null` removes the current converter. - * @return A Query that uses the provided converter. + * @returns A Query that uses the provided converter. */ withConverter< NewAppModelType, diff --git a/dev/src/reference/vector-query-options.ts b/dev/src/reference/vector-query-options.ts index 10a851a96..7aa1a9823 100644 --- a/dev/src/reference/vector-query-options.ts +++ b/dev/src/reference/vector-query-options.ts @@ -17,7 +17,7 @@ import * as firestore from '@google-cloud/firestore'; /** - * Specifies the behavior of the {@link VectorQuery} generated by a call to {@link Query.findNearest}. + * Specifies the behavior of the {@link VectorQuery} generated by a call to {@link Query.findNearest:VectorQueryOptions}. */ export interface VectorQueryOptions { /** diff --git a/dev/src/reference/vector-query.ts b/dev/src/reference/vector-query.ts index 56de19296..d702d9423 100644 --- a/dev/src/reference/vector-query.ts +++ b/dev/src/reference/vector-query.ts @@ -35,7 +35,7 @@ import {QueryResponse} from './types'; /** * A query that finds the documents whose vector fields are closest to a certain query vector. - * Create an instance of `VectorQuery` with {@link Query.findNearest}. + * Create an instance of `VectorQuery` with {@link Query.findNearest:VectorQueryOptions}. */ export class VectorQuery< AppModelType = firestore.DocumentData, @@ -111,7 +111,7 @@ export class VectorQuery< * resolved with the planner information, statistics from the query execution (if any), * and the query results (if any). * - * @return A Promise that will be resolved with the planner information, statistics + * @returns A Promise that will be resolved with the planner information, statistics * from the query execution (if any), and the query results (if any). */ async explain( diff --git a/dev/src/timestamp.ts b/dev/src/timestamp.ts index 202becb65..09ff1d086 100644 --- a/dev/src/timestamp.ts +++ b/dev/src/timestamp.ts @@ -71,7 +71,7 @@ export class Timestamp implements firestore.Timestamp { * documentRef.set({ updateTime:Firestore.Timestamp.now() }); * * ``` - * @return {Timestamp} A new `Timestamp` representing the current date. + * @returns {Timestamp} A new `Timestamp` representing the current date. */ static now(): Timestamp { return Timestamp.fromMillis(Date.now()); @@ -89,7 +89,7 @@ export class Timestamp implements firestore.Timestamp { * * ``` * @param {Date} date The date to initialize the `Timestamp` from. - * @return {Timestamp} A new `Timestamp` representing the same point in time + * @returns {Timestamp} A new `Timestamp` representing the same point in time * as the given date. */ static fromDate(date: Date): Timestamp { @@ -108,7 +108,7 @@ export class Timestamp implements firestore.Timestamp { * ``` * @param {number} milliseconds Number of milliseconds since Unix epoch * 1970-01-01T00:00:00Z. - * @return {Timestamp} A new `Timestamp` representing the same point in time + * @returns {Timestamp} A new `Timestamp` representing the same point in time * as the given number of milliseconds. */ static fromMillis(milliseconds: number): Timestamp { @@ -211,7 +211,7 @@ export class Timestamp implements firestore.Timestamp { * }); * * ``` - * @return {Date} JavaScript `Date` object representing the same point in time + * @returns {Date} JavaScript `Date` object representing the same point in time * as this `Timestamp`, with millisecond precision. */ toDate(): Date { @@ -234,7 +234,7 @@ export class Timestamp implements firestore.Timestamp { * }); * * ``` - * @return {number} The point in time corresponding to this timestamp, + * @returns {number} The point in time corresponding to this timestamp, * represented as the number of milliseconds since Unix epoch * 1970-01-01T00:00:00Z. */ @@ -257,7 +257,7 @@ export class Timestamp implements firestore.Timestamp { * * ``` * @param {any} other The `Timestamp` to compare against. - * @return {boolean} 'true' if this `Timestamp` is equal to the provided one. + * @returns {boolean} 'true' if this `Timestamp` is equal to the provided one. */ isEqual(other: firestore.Timestamp): boolean { return ( @@ -293,7 +293,7 @@ export class Timestamp implements firestore.Timestamp { * Converts this object to a primitive `string`, which allows `Timestamp` objects to be compared * using the `>`, `<=`, `>=` and `>` operators. * - * @return {string} a string encoding of this object. + * @returns {string} a string encoding of this object. */ valueOf(): string { // This method returns a string of the form . where is diff --git a/dev/src/transaction.ts b/dev/src/transaction.ts index b3cb2e670..968fb771d 100644 --- a/dev/src/transaction.ts +++ b/dev/src/transaction.ts @@ -133,7 +133,7 @@ export class Transaction implements firestore.Transaction { * documents. * * @param {Query} query A query to execute. - * @return {Promise} A QuerySnapshot for the retrieved data. + * @returns {Promise} A QuerySnapshot for the retrieved data. */ get( query: firestore.Query, @@ -144,7 +144,7 @@ export class Transaction implements firestore.Transaction { * Holds a pessimistic lock on the returned document. * * @param {DocumentReference} documentRef A reference to the document to be read. - * @return {Promise} A DocumentSnapshot for the read data. + * @returns {Promise} A DocumentSnapshot for the read data. */ get( documentRef: firestore.DocumentReference, @@ -155,7 +155,7 @@ export class Transaction implements firestore.Transaction { * documents that were matched by the underlying query. * * @param aggregateQuery An aggregate query to execute. - * @return An AggregateQuerySnapshot for the retrieved data. + * @returns An AggregateQuerySnapshot for the retrieved data. */ get< AppModelType, @@ -293,22 +293,22 @@ export class Transaction implements firestore.Transaction { *

    The returned Promise can be used to track the progress of the pipeline execution * and retrieve the results (or handle any errors) asynchronously. * - *

    The pipeline results are returned in a {@link PipelineSnapshot} object, which contains a list of - * {@link PipelineResult} objects. Each {@link PipelineResult} typically represents a single key/value map that + *

    The pipeline results are returned in a `PipelineSnapshot` object, which contains a list of + * `PipelineResult` objects. Each `PipelineResult` typically represents a single key/value map that * has passed through all the stages of the pipeline, however this might differ depending on the stages involved * in the pipeline. For example: * *

      - *
    • If there are no stages or only transformation stages, each {@link PipelineResult} + *
    • If there are no stages or only transformation stages, each `PipelineResult` * represents a single document.
      • - *
    • If there is an aggregation, only a single {@link PipelineResult} is returned, + *
    • If there is an aggregation, only a single `PipelineResult` is returned, * representing the aggregated results over the entire dataset .
      • - *
    • If there is an aggregation stage with grouping, each {@link PipelineResult} represents a + *
    • If there is an aggregation stage with grouping, each `PipelineResult` represents a * distinct group and its associated aggregated values.
      • *
    * - *

    Example: * + * @example * ```typescript * const futureResults = await transaction * .execute( @@ -317,7 +317,7 @@ export class Transaction implements firestore.Transaction { * .select("title", "author", "rating")); * ``` * - * @return A Promise representing the asynchronous pipeline execution. + * @returns A Promise representing the asynchronous pipeline execution. */ execute(pipeline: Pipeline): Promise { if (this._writeBatch && !this._writeBatch.isEmpty) { @@ -1009,7 +1009,7 @@ function isRetryableTransactionError(error: GoogleError): boolean { * * @private * @internal - * @return A Promise that resolves after the delay expired. + * @returns A Promise that resolves after the delay expired. */ async function maybeBackoff( backoff: ExponentialBackoff, diff --git a/dev/src/util.ts b/dev/src/util.ts index 8290471e2..d8ef4fd4f 100644 --- a/dev/src/util.ts +++ b/dev/src/util.ts @@ -246,7 +246,7 @@ export function wrapError(err: Error, stack: string): Error { * This function will warn to the console if the environment variable is set * to an unsupported value. * - * @return `true` if the environment variable enables `preferRest`, + * @returns `true` if the environment variable enables `preferRest`, * `false` if the environment variable disables `preferRest`, or `undefined` * if the environment variable is not set or is set to an unsupported value. * @@ -297,7 +297,7 @@ export function mapToArray( * @internal * @param left Array of objects supporting `isEqual`. * @param right Array of objects supporting `isEqual`. - * @return True if arrays are equal. + * @returns True if arrays are equal. */ export function isArrayEqual boolean}>( left: T[], @@ -323,7 +323,7 @@ export function isArrayEqual boolean}>( * @internal * @param left Optional object supporting `isEqual`. * @param right Optional object supporting `isEqual`. - * @return True if equal. + * @returns True if equal. */ export function isOptionalEqual boolean}>( left: T | undefined, @@ -347,7 +347,7 @@ export function isOptionalEqual boolean}>( * @internal * @param left Array of primitives. * @param right Array of primitives. - * @return True if arrays are equal. + * @returns True if arrays are equal. */ export function isPrimitiveArrayEqual( left: T[], diff --git a/dev/src/v1/firestore_admin_client.ts b/dev/src/v1/firestore_admin_client.ts index e7b49bd63..50570635f 100644 --- a/dev/src/v1/firestore_admin_client.ts +++ b/dev/src/v1/firestore_admin_client.ts @@ -5834,7 +5834,7 @@ export class FirestoreAdminClient { * * The second parameter to the callback is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. - * @return {Promise} - The promise which resolves to an array. + * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * The promise has a method named "cancel" which cancels the ongoing API call. @@ -5942,7 +5942,7 @@ export class FirestoreAdminClient { * details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. - * @return {Promise} - The promise which resolves when API call finishes. + * @returns {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * @@ -5999,7 +5999,7 @@ export class FirestoreAdminClient { * for the details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. - * @return {Promise} - The promise which resolves when API call finishes. + * @returns {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * diff --git a/dev/src/validate.ts b/dev/src/validate.ts index 6f65d0f1a..7a33461ec 100644 --- a/dev/src/validate.ts +++ b/dev/src/validate.ts @@ -332,7 +332,7 @@ export function invalidArgumentMessage( * @internal * @param value The input to validate. * @param options Whether the function can be omitted. - * @return Whether the object is omitted and is allowed to be omitted. + * @returns Whether the object is omitted and is allowed to be omitted. */ export function validateOptional( value: unknown, @@ -361,7 +361,7 @@ function formatPlural(num: number, str: string): string { * @private * @internal * @param arg The argument name or argument index (for varargs methods). - * @return Either the argument name or its index description. + * @returns Either the argument name or its index description. */ function formatArgumentName(arg: string | number): string { return typeof arg === 'string' diff --git a/dev/src/watch.ts b/dev/src/watch.ts index 740eeed79..72e3a4d20 100644 --- a/dev/src/watch.ts +++ b/dev/src/watch.ts @@ -825,7 +825,7 @@ abstract class Watch< * @private * @internal * @param error An error object. - * @return Whether the error is permanent. + * @returns Whether the error is permanent. */ private isPermanentWatchError(error: GoogleError): boolean { if (error.code === undefined) { @@ -860,7 +860,7 @@ abstract class Watch< * @private * @internal * @param error A GRPC Error object that exposes an error code. - * @return Whether we need to back off our retries. + * @returns Whether we need to back off our retries. */ private isResourceExhaustedError(error: GoogleError): boolean { return error.code === Status.RESOURCE_EXHAUSTED; diff --git a/dev/src/write-batch.ts b/dev/src/write-batch.ts index ad4a70b0e..0b9492011 100644 --- a/dev/src/write-batch.ts +++ b/dev/src/write-batch.ts @@ -92,7 +92,7 @@ export class WriteResult implements firestore.WriteResult { * Returns true if this `WriteResult` is equal to the provided value. * * @param {*} other The value to compare against. - * @return true if this `WriteResult` is equal to the provided value. + * @returns true if this `WriteResult` is equal to the provided value. */ isEqual(other: firestore.WriteResult): boolean { return ( diff --git a/dev/test/util/helpers.ts b/dev/test/util/helpers.ts index b10c81c5d..8a50a055b 100644 --- a/dev/test/util/helpers.ts +++ b/dev/test/util/helpers.ts @@ -58,7 +58,7 @@ export type ApiOverride = Partial; * * @param apiOverrides An object with request handlers to override. * @param firestoreSettings Firestore Settings to configure the client. - * @return A Promise that resolves with the new Firestore client. + * @returns A Promise that resolves with the new Firestore client. */ export function createInstance( apiOverrides?: ApiOverride, @@ -437,7 +437,7 @@ export async function bundleToElementArray( * }); * * @param iterator the iterator whose elements over which to iterate. - * @return a Promise that is fulfilled with the elements that were produced, or + * @returns a Promise that is fulfilled with the elements that were produced, or * is rejected with the cause of the first failed iteration. */ export async function collect( @@ -459,7 +459,7 @@ export async function collect( * Returns a value indicating whether preferRest is enabled * via the environment variable `FIRESTORE_PREFER_REST`. * - * @return `true` if preferRest is enabled via the environment variable `FIRESTORE_PREFER_REST`. + * @returns `true` if preferRest is enabled via the environment variable `FIRESTORE_PREFER_REST`. */ export function isPreferRest(): boolean { return ( diff --git a/dev/test/watch.ts b/dev/test/watch.ts index a4ba584bd..348f7f089 100644 --- a/dev/test/watch.ts +++ b/dev/test/watch.ts @@ -370,7 +370,7 @@ class WatchHelper { * Creates a watch, starts a listen, and asserts that the request got * processed. * - * @return The unsubscribe handler for the listener. + * @returns The unsubscribe handler for the listener. */ startWatch(): () => void { this.unsubscribe = this.reference.onSnapshot( @@ -387,7 +387,7 @@ class WatchHelper { /** * Ends the listen stream. * - * @return A Promise that will be fulfilled when the backend saw the end. + * @returns A Promise that will be fulfilled when the backend saw the end. */ async endWatch(): Promise { this.unsubscribe!(); diff --git a/scripts/api-report.mjs b/scripts/api-report.mjs index 4c5b0dcf5..6b68ef138 100644 --- a/scripts/api-report.mjs +++ b/scripts/api-report.mjs @@ -52,7 +52,27 @@ async function apiReport(opts) { 'ae-forgotten-export': { logLevel: 'warning', }, + 'ae-unresolved-link': { + // Error on unresolved link because this can + // lead to a bad user experience when reading docs. + logLevel: 'error' + }, + 'ae-extra-release-tag': { + // @internal tag is used for TSDoc + // @private tag is used for JSDoc + // TODO: Suppress this warning until we drop JSDoc. + logLevel: 'none' + } }, + tsdocMessageReporting: { + 'tsdoc-param-tag-missing-hyphen': { + // TSDoc and JSDoc use different formats for param tags. + // TSDoc works fine without the hypen, and JSDoc does not use it. + // TODO: Suppress this warning until we drop JSDoc. + logLevel: 'none', + "addToApiReportFile": false + } + } }, }; const apiExtractorConfigPath = join(cwd, 'api-extractor.json'); diff --git a/types/firestore.d.ts b/types/firestore.d.ts index 512e91f15..475cba7b3 100644 --- a/types/firestore.d.ts +++ b/types/firestore.d.ts @@ -575,7 +575,7 @@ declare namespace FirebaseFirestore { * the specified path. * * @param collectionPath A slash-separated path to a collection. - * @return The `CollectionReference` instance. + * @returns The `CollectionReference` instance. */ collection(collectionPath: string): CollectionReference; /** @@ -583,7 +583,7 @@ declare namespace FirebaseFirestore { * specified path. * * @param documentPath A slash-separated path to a document. - * @return The `DocumentReference` instance. + * @returns The `DocumentReference` instance. */ doc(documentPath: string): DocumentReference; /** @@ -594,7 +594,7 @@ declare namespace FirebaseFirestore { * @param collectionId Identifies the collections to query over. Every * collection or subcollection with this ID as the last segment of its path * will be included. Cannot contain a slash. - * @return The created `CollectionGroup`. + * @returns The created `CollectionGroup`. */ collectionGroup(collectionId: string): CollectionGroup; /** @@ -607,7 +607,7 @@ declare namespace FirebaseFirestore { * @param {Array.} documentRefsOrReadOptions * The `DocumentReferences` to receive, followed by an optional field * mask. - * @return A Promise that resolves with an array of resulting document + * @returns A Promise that resolves with an array of resulting document * snapshots. */ getAll( @@ -629,7 +629,7 @@ declare namespace FirebaseFirestore { * @param ref The reference of a document or collection to delete. * @param bulkWriter A custom BulkWriter instance used to perform the * deletes. - * @return A promise that resolves when all deletes have been performed. + * @returns A promise that resolves when all deletes have been performed. * The promise is rejected if any of the deletes fail. * * @example @@ -655,7 +655,7 @@ declare namespace FirebaseFirestore { /** * Terminates the Firestore client and closes all open streams. * - * @return A Promise that resolves when the client is terminated. + * @returns A Promise that resolves when the client is terminated. */ terminate(): Promise; /** @@ -697,7 +697,7 @@ declare namespace FirebaseFirestore { * @param updateFunction The function to execute within the transaction * context. * @param transactionOptions Transaction options. - * @return If the transaction completed successfully or was explicitly + * @returns If the transaction completed successfully or was explicitly * aborted (by the updateFunction returning a failed Promise), the Promise * returned by the updateFunction will be returned here. Else if the * transaction failed, a rejected Promise with the corresponding failure @@ -780,7 +780,7 @@ declare namespace FirebaseFirestore { * Returns true if this `GeoPoint` is equal to the provided one. * * @param other The `GeoPoint` to compare against. - * @return true if this `GeoPoint` is equal to the provided one. + * @returns true if this `GeoPoint` is equal to the provided one. */ isEqual(other: GeoPoint): boolean; } @@ -797,7 +797,7 @@ declare namespace FirebaseFirestore { * documents. * * @param query A query to execute. - * @return A QuerySnapshot for the retrieved data. + * @returns A QuerySnapshot for the retrieved data. */ get( query: Query, @@ -807,7 +807,7 @@ declare namespace FirebaseFirestore { * Holds a pessimistic lock on the returned document. * * @param documentRef A reference to the document to be read. - * @return A DocumentSnapshot for the read data. + * @returns A DocumentSnapshot for the read data. */ get( documentRef: DocumentReference, @@ -817,7 +817,7 @@ declare namespace FirebaseFirestore { * documents that were matched by the underlying query. * * @param aggregateQuery An aggregate query to execute. - * @return An AggregateQuerySnapshot for the retrieved data. + * @returns An AggregateQuerySnapshot for the retrieved data. */ get< AppModelType, @@ -843,7 +843,7 @@ declare namespace FirebaseFirestore { * @param {Array.} documentRefsOrReadOptions * The `DocumentReferences` to receive, followed by an optional field * mask. - * @return A Promise that resolves with an array of resulting document + * @returns A Promise that resolves with an array of resulting document * snapshots. */ getAll( @@ -859,7 +859,7 @@ declare namespace FirebaseFirestore { * @param documentRef A reference to the document to be create. * @param data The object data to serialize as the document. * @throws Error If the provided input is not a valid Firestore document. - * @return This `Transaction` instance. Used for chaining method calls. + * @returns This `Transaction` instance. Used for chaining method calls. */ create( documentRef: DocumentReference, @@ -882,7 +882,7 @@ declare namespace FirebaseFirestore { * and remains untouched. If your input sets any field to an empty map, all * nested fields are overwritten. * @throws Error If the provided input is not a valid Firestore document. - * @return This `Transaction` instance. Used for chaining method calls. + * @returns This `Transaction` instance. Used for chaining method calls. */ set( documentRef: DocumentReference, @@ -906,7 +906,7 @@ declare namespace FirebaseFirestore { * update the document. * @param precondition A Precondition to enforce on this update. * @throws Error If the provided input is not valid Firestore data. - * @return This `Transaction` instance. Used for chaining method calls. + * @returns This `Transaction` instance. Used for chaining method calls. */ update( documentRef: DocumentReference, @@ -931,7 +931,7 @@ declare namespace FirebaseFirestore { * to update, optionally followed by a `Precondition` to enforce on this * update. * @throws Error If the provided input is not valid Firestore data. - * @return This `Transaction` instance. Used for chaining method calls. + * @returns This `Transaction` instance. Used for chaining method calls. */ update( documentRef: DocumentReference, @@ -944,7 +944,7 @@ declare namespace FirebaseFirestore { * * @param documentRef A reference to the document to be deleted. * @param precondition A Precondition to enforce for this delete. - * @return This `Transaction` instance. Used for chaining method calls. + * @returns This `Transaction` instance. Used for chaining method calls. */ delete( documentRef: DocumentReference, @@ -956,22 +956,22 @@ declare namespace FirebaseFirestore { * The returned Promise can be used to track the progress of the pipeline execution * and retrieve the results (or handle any errors) asynchronously. * - *

    The pipeline results are returned in a {@link PipelineSnapshot} object, which contains a list of - * {@link PipelineResult} objects. Each {@link PipelineResult} typically represents a single key/value map that + *

    The pipeline results are returned in a `PipelineSnapshot` object, which contains a list of + * `PipelineResult` objects. Each `PipelineResult` typically represents a single key/value map that * has passed through all the stages of the pipeline, however this might differ depending on the stages involved * in the pipeline. For example: * *

      - *
    • If there are no stages or only transformation stages, each {@link PipelineResult} + *
    • If there are no stages or only transformation stages, each `PipelineResult` * represents a single document.
      • - *
    • If there is an aggregation, only a single {@link PipelineResult} is returned, + *
    • If there is an aggregation, only a single `PipelineResult` is returned, * representing the aggregated results over the entire dataset .
      • - *
    • If there is an aggregation stage with grouping, each {@link PipelineResult} represents a + *
    • If there is an aggregation stage with grouping, each `PipelineResult` represents a * distinct group and its associated aggregated values.
      • *
    * - *

    Example: * + * @example * ```typescript * const futureResults = await transaction * .execute( @@ -980,7 +980,7 @@ declare namespace FirebaseFirestore { * .select("title", "author", "rating")); * ``` * - * @return A Promise representing the asynchronous pipeline execution. + * @returns A Promise representing the asynchronous pipeline execution. */ execute(pipeline: Pipelines.Pipeline): Promise; } @@ -1162,7 +1162,7 @@ declare namespace FirebaseFirestore { * does not wait for writes that were added after the method is called. If * you want to wait for additional writes, call `flush()` again. * - * @return A promise that resolves when all enqueued writes + * @returns A promise that resolves when all enqueued writes * up to this point have been committed. */ flush(): Promise; @@ -1178,7 +1178,7 @@ declare namespace FirebaseFirestore { * requests. The promise resolves immediately if there are no pending * writes. * - * @return A promise that resolves when all enqueued writes + * @returns A promise that resolves when all enqueued writes * up to this point have been committed. */ close(): Promise; @@ -1247,7 +1247,7 @@ declare namespace FirebaseFirestore { * @param documentRef A reference to the document to be created. * @param data The object data to serialize as the document. * @throws Error If the provided input is not a valid Firestore document. - * @return This `WriteBatch` instance. Used for chaining method calls. + * @returns This `WriteBatch` instance. Used for chaining method calls. */ create( documentRef: DocumentReference, @@ -1270,7 +1270,7 @@ declare namespace FirebaseFirestore { * and remains untouched. If your input sets any field to an empty map, all * nested fields are overwritten. * @throws Error If the provided input is not a valid Firestore document. - * @return This `WriteBatch` instance. Used for chaining method calls. + * @returns This `WriteBatch` instance. Used for chaining method calls. */ set( documentRef: DocumentReference, @@ -1294,7 +1294,7 @@ declare namespace FirebaseFirestore { * update the document. * @param precondition A Precondition to enforce on this update. * @throws Error If the provided input is not valid Firestore data. - * @return This `WriteBatch` instance. Used for chaining method calls. + * @returns This `WriteBatch` instance. Used for chaining method calls. */ update( documentRef: DocumentReference, @@ -1319,7 +1319,7 @@ declare namespace FirebaseFirestore { * to update, optionally followed a `Precondition` to enforce on this * update. * @throws Error If the provided input is not valid Firestore data. - * @return This `WriteBatch` instance. Used for chaining method calls. + * @returns This `WriteBatch` instance. Used for chaining method calls. */ update( documentRef: DocumentReference, @@ -1332,7 +1332,7 @@ declare namespace FirebaseFirestore { * * @param documentRef A reference to the document to be deleted. * @param precondition A Precondition to enforce for this delete. - * @return This `WriteBatch` instance. Used for chaining method calls. + * @returns This `WriteBatch` instance. Used for chaining method calls. */ delete( documentRef: DocumentReference, @@ -1341,7 +1341,7 @@ declare namespace FirebaseFirestore { /** * Commits all of the writes in this write batch as a single atomic unit. * - * @return A Promise resolved once all of the writes in the batch have been + * @returns A Promise resolved once all of the writes in the batch have been * successfully written to the backend as an atomic unit. */ commit(): Promise; @@ -1415,7 +1415,7 @@ declare namespace FirebaseFirestore { * Returns true if this `WriteResult` is equal to the provided one. * * @param other The `WriteResult` to compare against. - * @return true if this `WriteResult` is equal to the provided one. + * @returns true if this `WriteResult` is equal to the provided one. */ isEqual(other: WriteResult): boolean; } @@ -1451,7 +1451,7 @@ declare namespace FirebaseFirestore { * the specified path. * * @param collectionPath A slash-separated path to a collection. - * @return The `CollectionReference` instance. + * @returns The `CollectionReference` instance. */ collection(collectionPath: string): CollectionReference; /** @@ -1466,7 +1466,7 @@ declare namespace FirebaseFirestore { * * @param data The object data to serialize as the document. * @throws {Error} If the provided input is not a valid Firestore document or if the document already exists. - * @return A Promise resolved with the write time of this create. + * @returns A Promise resolved with the write time of this create. */ create(data: WithFieldValue): Promise; /** @@ -1485,7 +1485,7 @@ declare namespace FirebaseFirestore { * and remains untouched. If your input sets any field to an empty map, all * nested fields are overwritten. * @throws Error If the provided input is not a valid Firestore document. - * @return A Promise resolved with the write time of this set. + * @returns A Promise resolved with the write time of this set. */ set( data: PartialWithFieldValue, @@ -1503,7 +1503,7 @@ declare namespace FirebaseFirestore { * update the document. * @param precondition A Precondition to enforce on this update. * @throws Error If the provided input is not valid Firestore data. - * @return A Promise resolved with the write time of this update. + * @returns A Promise resolved with the write time of this update. */ update( data: UpdateData, @@ -1525,7 +1525,7 @@ declare namespace FirebaseFirestore { * values to update, optionally followed by a `Precondition` to enforce on * this update. * @throws Error If the provided input is not valid Firestore data. - * @return A Promise resolved with the write time of this update. + * @returns A Promise resolved with the write time of this update. */ update( field: string | FieldPath, @@ -1536,13 +1536,13 @@ declare namespace FirebaseFirestore { * Deletes the document referred to by this `DocumentReference`. * * @param precondition A Precondition to enforce for this delete. - * @return A Promise resolved with the write time of this delete. + * @returns A Promise resolved with the write time of this delete. */ delete(precondition?: Precondition): Promise; /** * Reads the document referred to by this `DocumentReference`. * - * @return A Promise resolved with a DocumentSnapshot containing the + * @returns A Promise resolved with a DocumentSnapshot containing the * current document contents. */ get(): Promise>; @@ -1553,7 +1553,7 @@ declare namespace FirebaseFirestore { * is available. * @param onError A callback to be called if the listen fails or is * cancelled. No further callbacks will occur. - * @return An unsubscribe function that can be called to cancel + * @returns An unsubscribe function that can be called to cancel * the snapshot listener. */ onSnapshot( @@ -1564,7 +1564,7 @@ declare namespace FirebaseFirestore { * Returns true if this `DocumentReference` is equal to the provided one. * * @param other The `DocumentReference` to compare against. - * @return true if this `DocumentReference` is equal to the provided one. + * @returns true if this `DocumentReference` is equal to the provided one. */ isEqual(other: DocumentReference): boolean; /** @@ -1576,7 +1576,7 @@ declare namespace FirebaseFirestore { * * @param converter Converts objects to and from Firestore. Passing in * `null` removes the current converter. - * @return A DocumentReference that uses the provided converter. + * @returns A DocumentReference that uses the provided converter. */ withConverter< NewAppModelType, @@ -1625,14 +1625,14 @@ declare namespace FirebaseFirestore { * Retrieves all fields in the document as an Object. Returns 'undefined' if * the document doesn't exist. * - * @return An Object containing all fields in the document. + * @returns An Object containing all fields in the document. */ data(): AppModelType | undefined; /** * Retrieves the field specified by `fieldPath`. * * @param fieldPath The path (e.g. 'foo' or 'foo.bar') to a specific field. - * @return The data at the specified field location or undefined if no such + * @returns The data at the specified field location or undefined if no such * field exists in the document. */ get(fieldPath: string | FieldPath): any; @@ -1641,7 +1641,7 @@ declare namespace FirebaseFirestore { * is equal to the provided one. * * @param other The `DocumentSnapshot` to compare against. - * @return true if this `DocumentSnapshot` is equal to the provided one. + * @returns true if this `DocumentSnapshot` is equal to the provided one. */ isEqual(other: DocumentSnapshot): boolean; } @@ -1674,7 +1674,7 @@ declare namespace FirebaseFirestore { * Retrieves all fields in the document as an Object. * * @override - * @return An Object containing all fields in the document. + * @returns An Object containing all fields in the document. */ data(): AppModelType; } @@ -1724,7 +1724,7 @@ declare namespace FirebaseFirestore { * @param fieldPath The path to compare * @param opStr The operation string (e.g "<", "<=", "==", ">", ">="). * @param value The value for comparison - * @return The created Query. + * @returns The created Query. */ where( fieldPath: string | FieldPath, @@ -1753,7 +1753,7 @@ declare namespace FirebaseFirestore { * @param fieldPath The field to sort by. * @param directionStr Optional direction to sort by ('asc' or 'desc'). If * not specified, order will be ascending. - * @return The created Query. + * @returns The created Query. */ orderBy( fieldPath: string | FieldPath, @@ -1767,7 +1767,7 @@ declare namespace FirebaseFirestore { * than modify the existing instance) to impose the limit. * * @param limit The maximum number of items to return. - * @return The created Query. + * @returns The created Query. */ limit(limit: number): Query; /** @@ -1781,7 +1781,7 @@ declare namespace FirebaseFirestore { * API. * * @param limit The maximum number of items to return. - * @return The created Query. + * @returns The created Query. */ limitToLast(limit: number): Query; /** @@ -1791,7 +1791,7 @@ declare namespace FirebaseFirestore { * than modify the existing instance) to impose the offset. * * @param offset The offset to apply to the Query results. - * @return The created Query. + * @returns The created Query. */ offset(offset: number): Query; /** @@ -1807,7 +1807,7 @@ declare namespace FirebaseFirestore { * than modify the existing instance) to impose the field mask. * * @param field The field paths to return. - * @return The created Query. + * @returns The created Query. */ select(...field: (string | FieldPath)[]): Query; /** @@ -1817,7 +1817,7 @@ declare namespace FirebaseFirestore { * this query. * * @param snapshot The snapshot of the document to start after. - * @return The created Query. + * @returns The created Query. */ startAt( snapshot: DocumentSnapshot, @@ -1829,7 +1829,7 @@ declare namespace FirebaseFirestore { * * @param fieldValues The field values to start this query at, in order * of the query's order by. - * @return The created Query. + * @returns The created Query. */ startAt(...fieldValues: any[]): Query; /** @@ -1839,7 +1839,7 @@ declare namespace FirebaseFirestore { * this query. * * @param snapshot The snapshot of the document to start after. - * @return The created Query. + * @returns The created Query. */ startAfter( snapshot: DocumentSnapshot, @@ -1851,7 +1851,7 @@ declare namespace FirebaseFirestore { * * @param fieldValues The field values to start this query after, in order * of the query's order by. - * @return The created Query. + * @returns The created Query. */ startAfter(...fieldValues: any[]): Query; /** @@ -1861,7 +1861,7 @@ declare namespace FirebaseFirestore { * query. * * @param snapshot The snapshot of the document to end before. - * @return The created Query. + * @returns The created Query. */ endBefore( snapshot: DocumentSnapshot, @@ -1873,7 +1873,7 @@ declare namespace FirebaseFirestore { * * @param fieldValues The field values to end this query before, in order * of the query's order by. - * @return The created Query. + * @returns The created Query. */ endBefore(...fieldValues: any[]): Query; /** @@ -1883,7 +1883,7 @@ declare namespace FirebaseFirestore { * query. * * @param snapshot The snapshot of the document to end at. - * @return The created Query. + * @returns The created Query. */ endAt( snapshot: DocumentSnapshot, @@ -1895,13 +1895,13 @@ declare namespace FirebaseFirestore { * * @param fieldValues The field values to end this query at, in order * of the query's order by. - * @return The created Query. + * @returns The created Query. */ endAt(...fieldValues: any[]): Query; /** * Executes the query and returns the results as a `QuerySnapshot`. * - * @return A Promise that will be resolved with the results of the Query. + * @returns A Promise that will be resolved with the results of the Query. */ get(): Promise>; /** @@ -1909,7 +1909,7 @@ declare namespace FirebaseFirestore { * resolved with the planner information, statistics from the query execution (if any), * and the query results (if any). * - * @return A Promise that will be resolved with the planner information, statistics + * @returns A Promise that will be resolved with the planner information, statistics * from the query execution (if any), and the query results (if any). */ explain( @@ -1918,7 +1918,7 @@ declare namespace FirebaseFirestore { /** * Executes the query and returns the results as Node Stream. * - * @return A stream of QueryDocumentSnapshot. + * @returns A stream of QueryDocumentSnapshot. */ stream(): NodeJS.ReadableStream; /** @@ -1948,7 +1948,7 @@ declare namespace FirebaseFirestore { * }); * ``` * - * @return A stream of `{document?: DocumentSnapshot, metrics?: ExplainMetrics}` + * @returns A stream of `{document?: DocumentSnapshot, metrics?: ExplainMetrics}` * objects. */ explainStream(options?: ExplainOptions): NodeJS.ReadableStream; @@ -1959,7 +1959,7 @@ declare namespace FirebaseFirestore { * is available. * @param onError A callback to be called if the listen fails or is * cancelled. No further callbacks will occur. - * @return An unsubscribe function that can be called to cancel + * @returns An unsubscribe function that can be called to cancel * the snapshot listener. */ onSnapshot( @@ -1978,7 +1978,7 @@ declare namespace FirebaseFirestore { * query can count the documents in cases where the result set is * prohibitively large to download entirely (thousands of documents). * - * @return a query that counts the documents in the result set of this + * @returns a query that counts the documents in the result set of this * query. The count can be retrieved from `snapshot.data().count`, where * `snapshot` is the `AggregateQuerySnapshot` resulting from running the * returned query. @@ -2048,7 +2048,7 @@ declare namespace FirebaseFirestore { * be a positive integer with a maximum value of 1000. `distanceMeasure` specifies what type of distance is calculated * when performing the query. * - * @deprecated Use the new {@link findNearest} implementation + * @deprecated Use the new {@link Query.findNearest:VectorQueryOptions} implementation * accepting a single `options` param. */ findNearest( @@ -2125,7 +2125,7 @@ declare namespace FirebaseFirestore { * Returns true if this `Query` is equal to the provided one. * * @param other The `Query` to compare against. - * @return true if this `Query` is equal to the provided one. + * @returns true if this `Query` is equal to the provided one. */ isEqual(other: Query): boolean; /** @@ -2136,7 +2136,7 @@ declare namespace FirebaseFirestore { * * @param converter Converts objects to and from Firestore. Passing in * `null` removes the current converter. - * @return A Query that uses the provided converter. + * @returns A Query that uses the provided converter. */ withConverter< NewAppModelType, @@ -2194,7 +2194,7 @@ declare namespace FirebaseFirestore { * provided one. * * @param other The `QuerySnapshot` to compare against. - * @return true if this `QuerySnapshot` is equal to the provided one. + * @returns true if this `QuerySnapshot` is equal to the provided one. */ isEqual(other: QuerySnapshot): boolean; } @@ -2247,7 +2247,7 @@ declare namespace FirebaseFirestore { * provided one. * * @param other The `VectorQuerySnapshot` to compare against. - * @return true if this `VectorQuerySnapshot` is equal to the provided one. + * @returns true if this `VectorQuerySnapshot` is equal to the provided one. */ isEqual(other: VectorQuerySnapshot): boolean; } @@ -2285,7 +2285,7 @@ declare namespace FirebaseFirestore { * provided one. * * @param other The `DocumentChange` to compare against. - * @return true if this `DocumentChange` is equal to the provided one. + * @returns true if this `DocumentChange` is equal to the provided one. */ isEqual(other: DocumentChange): boolean; } @@ -2320,7 +2320,7 @@ declare namespace FirebaseFirestore { * document reference (e.g. via `.get()` or `.onSnapshot()`) will return a * `DocumentSnapshot` whose `.exists` property is false. * - * @return {Promise} The list of documents in this + * @returns {Promise} The list of documents in this * collection. */ listDocuments(): Promise< @@ -2331,7 +2331,7 @@ declare namespace FirebaseFirestore { * collection. An automatically-generated unique ID will be used as the * document ID. * - * @return The `DocumentReference` instance. + * @returns The `DocumentReference` instance. */ doc(): DocumentReference; /** @@ -2339,7 +2339,7 @@ declare namespace FirebaseFirestore { * specified path. * * @param documentPath A slash-separated path to a document. - * @return The `DocumentReference` instance. + * @returns The `DocumentReference` instance. */ doc(documentPath: string): DocumentReference; /** @@ -2348,7 +2348,7 @@ declare namespace FirebaseFirestore { * * @param data An Object containing the data for the new document. * @throws Error If the provided input is not a valid Firestore document. - * @return A Promise resolved with a `DocumentReference` pointing to the + * @returns A Promise resolved with a `DocumentReference` pointing to the * newly created document after it has been written to the backend. */ add( @@ -2358,7 +2358,7 @@ declare namespace FirebaseFirestore { * Returns true if this `CollectionReference` is equal to the provided one. * * @param other The `CollectionReference` to compare against. - * @return true if this `CollectionReference` is equal to the provided one. + * @returns true if this `CollectionReference` is equal to the provided one. */ isEqual(other: CollectionReference): boolean; /** @@ -2370,7 +2370,7 @@ declare namespace FirebaseFirestore { * * @param converter Converts objects to and from Firestore. Passing in * `null` removes the current converter. - * @return A CollectionReference that uses the provided converter. + * @returns A CollectionReference that uses the provided converter. */ withConverter< NewAppModelType, @@ -2396,7 +2396,7 @@ declare namespace FirebaseFirestore { * @param desiredPartitionCount The desired maximum number of partition * points. The number must be strictly positive. The actual number of * partitions returned may be fewer. - * @return An AsyncIterable of `QueryPartition`s. + * @returns An AsyncIterable of `QueryPartition`s. */ getPartitions( desiredPartitionCount: number, @@ -2445,7 +2445,7 @@ declare namespace FirebaseFirestore { * * @param converter Converts objects to and from Firestore. Passing in * `null` removes the current converter. - * @return A `CollectionGroup` that uses the provided converter. + * @returns A `CollectionGroup` that uses the provided converter. */ withConverter< NewAppModelType, @@ -2471,7 +2471,7 @@ declare namespace FirebaseFirestore { * destructured when passed to `startAt()` (for example with * `query.startAt(...queryPartition.startAt)`). * - * @return Cursor values that can be used with {@link Query#startAt} or + * @returns Cursor values that can be used with {@link Query#startAt} or * `undefined` if this is the first partition. */ get startAt(): unknown[] | undefined; @@ -2481,14 +2481,14 @@ declare namespace FirebaseFirestore { * destructured when passed to `endBefore()` (for example with * `query.endBefore(...queryPartition.endBefore)`). * - * @return Cursor values that can be used with {@link Query#endBefore} or + * @returns Cursor values that can be used with {@link Query#endBefore} or * `undefined` if this is the last partition. */ get endBefore(): unknown[] | undefined; /** * Returns a query that only returns the documents for this partition. * - * @return A query partitioned by a {@link Query#startAt} and {@link + * @returns A query partitioned by a {@link Query#startAt} and {@link * Query#endBefore} cursor. */ toQuery(): Query; @@ -2521,7 +2521,7 @@ declare namespace FirebaseFirestore { * `other` performs the same kind of aggregation on the same field (if any). * * @param other The object to compare to this object for equality. - * @return `true` if this object is "equal" to the given object, as + * @returns `true` if this object is "equal" to the given object, as * defined above, or `false` otherwise. */ isEqual(other: AggregateField): boolean; @@ -2571,7 +2571,7 @@ declare namespace FirebaseFirestore { /** * Executes this query. * - * @return A promise that will be resolved with the results of the query. + * @returns A promise that will be resolved with the results of the query. */ get(): Promise< AggregateQuerySnapshot @@ -2581,7 +2581,7 @@ declare namespace FirebaseFirestore { * resolved with the planner information, statistics from the query execution (if any), * and the query results (if any). * - * @return A Promise that will be resolved with the planner information, statistics + * @returns A Promise that will be resolved with the planner information, statistics * from the query execution (if any), and the query results (if any). */ explain( @@ -2600,7 +2600,7 @@ declare namespace FirebaseFirestore { * using `Query.isEqual()`. * * @param other The object to compare to this object for equality. - * @return `true` if this object is "equal" to the given object, as + * @returns `true` if this object is "equal" to the given object, as * defined above, or `false` otherwise. */ isEqual( @@ -2644,7 +2644,7 @@ declare namespace FirebaseFirestore { * `AggregateQuery.isEqual()`. * * @param other The object to compare to this object for equality. - * @return `true` if this object is "equal" to the given object, as + * @returns `true` if this object is "equal" to the given object, as * defined above, or `false` otherwise. */ isEqual( @@ -2668,7 +2668,7 @@ declare namespace FirebaseFirestore { /** * Executes this query. * - * @return A promise that will be resolved with the results of the query. + * @returns A promise that will be resolved with the results of the query. */ get(): Promise>; /** @@ -2680,7 +2680,7 @@ declare namespace FirebaseFirestore { * using `Query.isEqual()`. * * @param other The object to compare to this object for equality. - * @return `true` if this object is "equal" to the given object, as + * @returns `true` if this object is "equal" to the given object, as * defined above, or `false` otherwise. */ isEqual(other: VectorQuery): boolean; @@ -2709,7 +2709,7 @@ declare namespace FirebaseFirestore { * Returns a sentinel used with set(), create() or update() to include a * server-generated timestamp in the written data. * - * @return The FieldValue sentinel for use in a call to set(), create() or + * @returns The FieldValue sentinel for use in a call to set(), create() or * update(). */ static serverTimestamp(): FieldValue; @@ -2717,7 +2717,7 @@ declare namespace FirebaseFirestore { * Returns a sentinel for use with update() or set() with {merge:true} to * mark a field for deletion. * - * @return The FieldValue sentinel for use in a call to set() or update(). + * @returns The FieldValue sentinel for use in a call to set() or update(). */ static delete(): FieldValue; /** @@ -2734,7 +2734,7 @@ declare namespace FirebaseFirestore { * not yet exist, the transformation will set the field to the given value. * * @param n The value to increment by. - * @return The FieldValue sentinel for use in a call to set(), create() or + * @returns The FieldValue sentinel for use in a call to set(), create() or * update(). */ static increment(n: number): FieldValue; @@ -2747,7 +2747,7 @@ declare namespace FirebaseFirestore { * containing exactly the specified elements. * * @param elements The elements to union into the array. - * @return The FieldValue sentinel for use in a call to set(), create() or + * @returns The FieldValue sentinel for use in a call to set(), create() or * update(). */ static arrayUnion(...elements: any[]): FieldValue; @@ -2759,19 +2759,19 @@ declare namespace FirebaseFirestore { * not already an array it will be overwritten with an empty array. * * @param elements The elements to remove from the array. - * @return The FieldValue sentinel for use in a call to set(), create() or + * @returns The FieldValue sentinel for use in a call to set(), create() or * update(). */ static arrayRemove(...elements: any[]): FieldValue; /** - * @return A new `VectorValue` constructed with a copy of the given array of number. + * @returns A new `VectorValue` constructed with a copy of the given array of number. */ static vector(values?: number[]): VectorValue; /** * Returns true if this `FieldValue` is equal to the provided one. * * @param other The `FieldValue` to compare against. - * @return true if this `FieldValue` is equal to the provided one. + * @returns true if this `FieldValue` is equal to the provided one. */ isEqual(other: FieldValue): boolean; } @@ -2797,7 +2797,7 @@ declare namespace FirebaseFirestore { * 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. + * @returns true if this `FieldPath` is equal to the provided one. */ isEqual(other: FieldPath): boolean; } @@ -2816,14 +2816,14 @@ declare namespace FirebaseFirestore { /** * Creates a new timestamp with the current date, with millisecond precision. * - * @return A new `Timestamp` representing the current date. + * @returns A new `Timestamp` representing the current date. */ static now(): Timestamp; /** * Creates a new timestamp from the given date. * * @param date The date to initialize the `Timestamp` from. - * @return A new `Timestamp` representing the same point in time as the + * @returns A new `Timestamp` representing the same point in time as the * given date. */ static fromDate(date: Date): Timestamp; @@ -2832,7 +2832,7 @@ declare namespace FirebaseFirestore { * * @param milliseconds Number of milliseconds since Unix epoch * 1970-01-01T00:00:00Z. - * @return A new `Timestamp` representing the same point in time as the + * @returns A new `Timestamp` representing the same point in time as the * given number of milliseconds. */ static fromMillis(milliseconds: number): Timestamp; @@ -2858,14 +2858,14 @@ declare namespace FirebaseFirestore { * Returns a new `Date` corresponding to this timestamp. This may lose * precision. * - * @return JavaScript `Date` object representing the same point in time as + * @returns JavaScript `Date` object representing the same point in time as * this `Timestamp`, with millisecond precision. */ toDate(): Date; /** * Returns the number of milliseconds since Unix epoch 1970-01-01T00:00:00Z. * - * @return The point in time corresponding to this timestamp, represented as + * @returns The point in time corresponding to this timestamp, represented as * the number of milliseconds since Unix epoch 1970-01-01T00:00:00Z. */ toMillis(): number; @@ -2873,14 +2873,14 @@ declare namespace FirebaseFirestore { * Returns true if this `Timestamp` is equal to the provided one. * * @param other The `Timestamp` to compare against. - * @return 'true' if this `Timestamp` is equal to the provided one. + * @returns 'true' if this `Timestamp` is equal to the provided one. */ isEqual(other: Timestamp): boolean; /** * Converts this object to a primitive `string`, which allows `Timestamp` objects to be compared * using the `>`, `<=`, `>=` and `>` operators. * - * @return a string encoding of this object. + * @returns a string encoding of this object. */ valueOf(): string; } @@ -3136,7 +3136,7 @@ declare namespace FirebaseFirestore { readonly snapshot: T | null; } /** - * Specifies the behavior of the {@link VectorQuery} generated by a call to {@link Query.findNearest}. + * Specifies the behavior of the {@link VectorQuery} generated by a call to {@link Query.findNearest:VectorQueryOptions}. */ export interface VectorQueryOptions { /** @@ -3178,7 +3178,7 @@ declare namespace FirebaseFirestore { * @beta * Represents an expression that has been assigned an alias using the `.as()` method. * - * This class wraps an existing {@link Expression} and associates it with a user-defined alias, + * This class wraps an existing `Expression` and associates it with a user-defined alias, * allowing the expression's result to be referred to by a different name in the output * of a Firestore pipeline query, particularly within `select()` operations. * @@ -3212,6 +3212,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that adds this expression to another expression. * + * @example * ```typescript * // Add the value of the 'quantity' field and the 'reserve' field. * field("quantity").add(field("reserve")); @@ -3219,7 +3220,7 @@ declare namespace FirebaseFirestore { * * @param second The expression or literal to add to this expression. * @param others Optional additional expressions or literals to add to this expression. - * @return A new `Expression` representing the addition operation. + * @returns A new `Expression` representing the addition operation. */ add( second: Expression | unknown, @@ -3229,39 +3230,42 @@ declare namespace FirebaseFirestore { * @beta * Wraps the expression in a [BooleanExpression]. * - * @return A [BooleanExpression] representing the same expression. + * @returns A [BooleanExpression] representing the same expression. */ asBoolean(): BooleanExpression; /** * @beta * Creates an expression that subtracts another expression from this expression. * + * @example * ```typescript * // Subtract the 'discount' field from the 'price' field * field("price").subtract(field("discount")); * ``` * * @param subtrahend The expression to subtract from this expression. - * @return A new `Expression` representing the subtraction operation. + * @returns A new `Expression` representing the subtraction operation. */ subtract(subtrahend: Expression): FunctionExpression; /** * @beta * Creates an expression that subtracts a constant value from this expression. * + * @example * ```typescript * // Subtract 20 from the value of the 'total' field * field("total").subtract(20); * ``` * * @param subtrahend The constant value to subtract. - * @return A new `Expression` representing the subtraction operation. + * @returns A new `Expression` representing the subtraction operation. */ subtract(subtrahend: number): FunctionExpression; /** * @beta * Creates an expression that multiplies this expression by another expression. * + * @example * ```typescript * // Multiply the 'quantity' field by the 'price' field * field("quantity").multiply(field("price")); @@ -3269,7 +3273,7 @@ declare namespace FirebaseFirestore { * * @param second The second expression or literal to multiply by. * @param others Optional additional expressions or literals to multiply by. - * @return A new `Expression` representing the multiplication operation. + * @returns A new `Expression` representing the multiplication operation. */ multiply( second: Expression | number, @@ -3279,52 +3283,56 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that divides this expression by another expression. * + * @example * ```typescript * // Divide the 'total' field by the 'count' field * field("total").divide(field("count")); * ``` * * @param divisor The expression to divide by. - * @return A new `Expression` representing the division operation. + * @returns A new `Expression` representing the division operation. */ divide(divisor: Expression): FunctionExpression; /** * @beta * Creates an expression that divides this expression by a constant value. * + * @example * ```typescript * // Divide the 'value' field by 10 * field("value").divide(10); * ``` * * @param divisor The constant value to divide by. - * @return A new `Expression` representing the division operation. + * @returns A new `Expression` representing the division operation. */ divide(divisor: number): FunctionExpression; /** * @beta * Creates an expression that calculates the modulo (remainder) of dividing this expression by another expression. * + * @example * ```typescript * // Calculate the remainder of dividing the 'value' field by the 'divisor' field * field("value").mod(field("divisor")); * ``` * * @param expression The expression to divide by. - * @return A new `Expression` representing the modulo operation. + * @returns A new `Expression` representing the modulo operation. */ mod(expression: Expression): FunctionExpression; /** * @beta * Creates an expression that calculates the modulo (remainder) of dividing this expression by a constant value. * + * @example * ```typescript * // Calculate the remainder of dividing the 'value' field by 10 * field("value").mod(10); * ``` * * @param value The constant value to divide by. - * @return A new `Expression` representing the modulo operation. + * @returns A new `Expression` representing the modulo operation. */ mod(value: number): FunctionExpression; @@ -3332,6 +3340,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if this expression is equal to another expression. * + * @example * ```typescript * // Check if the 'age' field is equal to the value of another field named 'otherAge'. * field("age").equal(field("otherAge")); @@ -3341,20 +3350,21 @@ declare namespace FirebaseFirestore { * ``` * * @param expression The expression to compare for equality. - * @return A new `BooleanExpression` representing the equality comparison. + * @returns A new `BooleanExpression` representing the equality comparison. */ equal(expression: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if this expression is equal to a constant value. * + * @example * ```typescript * // Check if the 'city' field is equal to "London" * field("city").equal("London"); * ``` * * @param value The constant value to compare for equality. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ equal(value: unknown): BooleanExpression; @@ -3362,26 +3372,28 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if this expression is not equal to another expression. * + * @example * ```typescript * // Check if the 'status' field is not equal to "completed" * field("status").notEqual("completed"); * ``` * * @param expression The expression to compare for inequality. - * @return A new {@link BooleanExpression} representing the inequality comparison. + * @returns A new `BooleanExpression` representing the inequality comparison. */ notEqual(expression: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if this expression is not equal to a constant value. * + * @example * ```typescript * // Check if the 'country' field is not equal to "USA" * field("country").notEqual("USA"); * ``` * * @param value The constant value to compare for inequality. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ notEqual(value: unknown): BooleanExpression; @@ -3389,26 +3401,28 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if this expression is less than another expression. * + * @example * ```typescript * // Check if the 'age' field is less than 'limit' * field("age").lessThan(field('limit')); * ``` * * @param expression The expression to compare against. - * @return A new `BooleanExpression` representing the less than comparison. + * @returns A new `BooleanExpression` representing the less than comparison. */ lessThan(expression: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if this expression is less than a constant value. * + * @example * ```typescript * // Check if the 'price' field is less than 50 * field("price").lessThan(50); * ``` * * @param value The constant value to compare for less than. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ lessThan(value: unknown): BooleanExpression; @@ -3416,26 +3430,28 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if the current expression's value is less than or equal to the value of another expression. * + * @example * ```typescript * // Check if the 'quantity' field is less than or equal to 20 * field("quantity").lessThanOrEqual(constant(20)); * ``` * * @param expression The expression to compare against. - * @return A new `BooleanExpression` representing the less than or equal to comparison. + * @returns A new `BooleanExpression` representing the less than or equal to comparison. */ lessThanOrEqual(expression: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if this expression is less than or equal to a constant value. * + * @example * ```typescript * // Check if the 'score' field is less than or equal to 70 * field("score").lessThanOrEqual(70); * ``` * * @param value The constant value to compare for less than or equal to. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ lessThanOrEqual(value: unknown): BooleanExpression; @@ -3443,26 +3459,28 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if this expression is greater than another expression. * + * @example * ```typescript * // Check if the 'age' field is greater than the 'limit' field * field("age").greaterThan(field("limit")); * ``` * * @param expression The expression to compare for greater than. - * @return A new {@link BooleanExpression} representing the greater than comparison. + * @returns A new `BooleanExpression` representing the greater than comparison. */ greaterThan(expression: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if this expression is greater than a constant value. * + * @example * ```typescript * // Check if the 'price' field is greater than 100 * field("price").greaterThan(100); * ``` * * @param value The constant value to compare for greater than. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ greaterThan(value: unknown): BooleanExpression; /** @@ -3470,13 +3488,14 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if this expression is greater than or equal to another * expression. * + * @example * ```typescript * // Check if the 'quantity' field is greater than or equal to field 'requirement' plus 1 * field("quantity").greaterThanOrEqual(field('requirement').add(1)); * ``` * * @param expression The expression to compare for greater than or equal to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ greaterThanOrEqual(expression: Expression): BooleanExpression; /** @@ -3484,13 +3503,14 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if this expression is greater than or equal to a constant * value. * + * @example * ```typescript * // Check if the 'score' field is greater than or equal to 80 * field("score").greaterThanOrEqual(80); * ``` * * @param value The constant value to compare for greater than or equal to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ greaterThanOrEqual(value: unknown): BooleanExpression; @@ -3498,13 +3518,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that concatenates an array expression with one or more other arrays. * + * @example * ```typescript * // Combine the 'items' array with another array field. * field("items").arrayConcat(field("otherItems")); * ``` * @param secondArray Second array expression or array literal to concatenate. * @param otherArrays Optional additional array expressions or array literals to concatenate. - * @return A new `Expr` representing the concatenated array. + * @returns A new `Expr` representing the concatenated array. */ arrayConcat( secondArray: Expression | unknown[], @@ -3515,71 +3536,77 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if an array contains a specific element. * + * @example * ```typescript * // Check if the 'sizes' array contains the value from the 'selectedSize' field * field("sizes").arrayContains(field("selectedSize")); * ``` * * @param expression The element to search for in the array. - * @return A new `Expression` representing the 'array_contains' comparison. + * @returns A new `Expression` representing the 'array_contains' comparison. */ arrayContains(expression: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if an array contains a specific value. * + * @example * ```typescript * // Check if the 'colors' array contains "red" * field("colors").arrayContains("red"); * ``` * * @param value The element to search for in the array. - * @return A new `Expression` representing the 'array_contains' comparison. + * @returns A new `Expression` representing the 'array_contains' comparison. */ arrayContains(value: unknown): BooleanExpression; /** * @beta * Creates an expression that checks if an array contains all the specified elements. * + * @example * ```typescript * // Check if the 'tags' array contains both the value in field "tag1" and the literal value "tag2" * field("tags").arrayContainsAll([field("tag1"), "tag2"]); * ``` * * @param values The elements to check for in the array. - * @return A new `Expression` representing the 'array_contains_all' comparison. + * @returns A new `Expression` representing the 'array_contains_all' comparison. */ arrayContainsAll(values: Array): BooleanExpression; /** * @beta * Creates an expression that checks if an array contains all the specified elements. * + * @example * ```typescript * // Check if the 'tags' array contains both of the values from field "tag1" and the literal value "tag2" * field("tags").arrayContainsAll(array([field("tag1"), "tag2"])); * ``` * * @param arrayExpression The elements to check for in the array. - * @return A new `Expression` representing the 'array_contains_all' comparison. + * @returns A new `Expression` representing the 'array_contains_all' comparison. */ arrayContainsAll(arrayExpression: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if an array contains any of the specified elements. * + * @example * ```typescript * // Check if the 'categories' array contains either values from field "cate1" or "cate2" * field("categories").arrayContainsAny([field("cate1"), field("cate2")]); * ``` * * @param values The elements to check for in the array. - * @return A new `Expression` representing the 'array_contains_any' comparison. + * @returns A new `Expression` representing the 'array_contains_any' comparison. */ arrayContainsAny(values: Array): BooleanExpression; /** * @beta * Creates an expression that checks if an array contains any of the specified elements. * + * @example * ```typescript * // Check if the 'groups' array contains either the value from the 'userGroup' field * // or the value "guest" @@ -3587,19 +3614,20 @@ declare namespace FirebaseFirestore { * ``` * * @param arrayExpression The elements to check for in the array. - * @return A new `Expression` representing the 'array_contains_any' comparison. + * @returns A new `Expression` representing the 'array_contains_any' comparison. */ arrayContainsAny(arrayExpression: Expression): BooleanExpression; /** * @beta * Creates an expression that calculates the length of an array. * + * @example * ```typescript * // Get the number of items in the 'cart' array * field("cart").arrayLength(); * ``` * - * @return A new `Expression` representing the length of the array. + * @returns A new `Expression` representing the length of the array. */ arrayLength(): FunctionExpression; @@ -3608,13 +3636,14 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if this expression is equal to any of the provided values or * expressions. * + * @example * ```typescript * // Check if the 'category' field is either "Electronics" or the value of field 'primaryType' * field("category").equalAny(["Electronics", field("primaryType")]); * ``` * * @param values An array of values or expressions to check against. - * @return A new `BooleanExpression` representing the 'IN' comparison. + * @returns A new `BooleanExpression` representing the 'IN' comparison. */ equalAny(values: Array): BooleanExpression; /** @@ -3622,13 +3651,14 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if this expression is equal to any of the provided values or * expressions. * + * @example * ```typescript * // Check if the 'category' field is either "Electronics" or the value of field 'primaryType' * field("category").equalAny(array(["Electronics", field("primaryType")])); * ``` * * @param arrayExpression An expression that evaluates to an array of values to check against. - * @return A new `Expression` representing the 'IN' comparison. + * @returns A new `Expression` representing the 'IN' comparison. */ equalAny(arrayExpression: Expression): BooleanExpression; /** @@ -3636,13 +3666,14 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if this expression is not equal to any of the provided values or * expressions. * + * @example * ```typescript * // Check if the 'status' field is neither "pending" nor the value of 'rejectedStatus' * field("status").notEqualAny(["pending", field("rejectedStatus")]); * ``` * * @param values The values or expressions to check against. - * @return A new `Expression` representing the 'NotEqAny' comparison. + * @returns A new `Expression` representing the 'NotEqAny' comparison. */ notEqualAny(values: Array): BooleanExpression; @@ -3650,13 +3681,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if the current expression's value is not equal to any of the values within the array produced by the `arrayExpression`. * + * @example * ```typescript * // Check if the 'status' field is not equal to any value in the array returned by the 'rejectedStatuses' field. * field("status").notEqualAny(field('rejectedStatuses')); * ``` * * @param arrayExpression An `Expression` that evaluates to an array of values to compare against. - * @return A new `BooleanExpression` representing the result of the 'not equal to any' comparison. + * @returns A new `BooleanExpression` representing the result of the 'not equal to any' comparison. */ notEqualAny(arrayExpression: Expression): BooleanExpression; @@ -3664,24 +3696,26 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field exists in the document. * + * @example * ```typescript * // Check if the document has a field named "phoneNumber" * field("phoneNumber").exists(); * ``` * - * @returns A new {@link BooleanExpression} representing the 'exists' check. + * @returns A new `BooleanExpression` representing the 'exists' check. */ exists(): BooleanExpression; /** * @beta * Creates an expression that calculates the character length of a string in UTF-8. * + * @example * ```typescript * // Get the character length of the 'name' field in its UTF-8 form. * field("name").charLength(); * ``` * - * @return A new `Expression` representing the length of the string. + * @returns A new `Expression` representing the length of the string. */ charLength(): FunctionExpression; @@ -3689,13 +3723,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that performs a case-sensitive string comparison. * + * @example * ```typescript * // Check if the 'title' field contains the word "guide" (case-sensitive) * field("title").like("%guide%"); * ``` * * @param pattern The string pattern to search for. You can use "%" as a wildcard character within the pattern. - * @return A new {@link BooleanExpression} representing the 'like' comparison. + * @returns A new `BooleanExpression` representing the 'like' comparison. */ like(pattern: string): BooleanExpression; @@ -3703,13 +3738,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that performs a case-sensitive string comparison. * + * @example * ```typescript * // Check if the 'description' field matches a pattern from another field * field("description").like(field("searchPattern")); * ``` * - * @param pattern An {@link Expression} that evaluates to the string pattern to search for. You can use "%" as a wildcard character within the pattern. - * @return A new {@link BooleanExpression} representing the 'like' comparison. + * @param pattern An `Expression` that evaluates to the string pattern to search for. You can use "%" as a wildcard character within the pattern. + * @returns A new `BooleanExpression` representing the 'like' comparison. */ like(pattern: Expression): BooleanExpression; /** @@ -3717,13 +3753,14 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if a string contains a specified regular expression as a * substring. * + * @example * ```typescript * // Check if the 'description' field contains "example" (case-insensitive) * field("description").regexContains("(?i)example"); * ``` * * @param pattern The regular expression to use for the search. - * @return A new `BooleanExpression` representing the 'contains' comparison. + * @returns A new `BooleanExpression` representing the 'contains' comparison. */ regexContains(pattern: string): BooleanExpression; @@ -3732,26 +3769,28 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if a string contains a specified regular expression as a * substring. * + * @example * ```typescript * // Check if the 'description' field contains the regular expression stored in field 'regex' * field("description").regexContains(field("regex")); * ``` * * @param pattern The regular expression to use for the search. - * @return A new {@link BooleanExpression} representing the 'contains' comparison. + * @returns A new `BooleanExpression` representing the 'contains' comparison. */ regexContains(pattern: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if a string matches a specified regular expression. * + * @example * ```typescript * // Check if the 'email' field matches a valid email pattern * field("email").regexMatch("[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}"); * ``` * * @param pattern The regular expression to use for the match. - * @return A new `Expression` representing the regular expression match. + * @returns A new `Expression` representing the regular expression match. */ regexMatch(pattern: string): BooleanExpression; @@ -3759,26 +3798,28 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a string matches a specified regular expression. * + * @example * ```typescript * // Check if the 'email' field matches a regular expression stored in another field. * field("email").regexMatch(field("regexPattern")); * ``` * * @param pattern An expression that evaluates to the regular expression string to use for the match. - * @return A new `BooleanExpression` representing the result of the regular expression match. + * @returns A new `BooleanExpression` representing the result of the regular expression match. */ regexMatch(pattern: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if a string contains a specified substring. * + * @example * ```typescript * // Check if the 'description' field contains "example". * field("description").stringContains("example"); * ``` * * @param substring The substring to search for. - * @return A new `Expression` representing the 'contains' comparison. + * @returns A new `Expression` representing the 'contains' comparison. */ stringContains(substring: string): BooleanExpression; @@ -3786,26 +3827,28 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a string contains the string represented by another expression. * + * @example * ```typescript * // Check if the 'description' field contains the value of the 'keyword' field. * field("description").stringContains(field("keyword")); * ``` * * @param expr The expression representing the substring to search for. - * @return A new {@link BooleanExpression} representing the 'contains' comparison. + * @returns A new `BooleanExpression` representing the 'contains' comparison. */ stringContains(expr: Expression): BooleanExpression; /** * @beta * Creates an expression that checks if a string starts with a given prefix. * + * @example * ```typescript * // Check if the 'name' field starts with "Mr." * field("name").startsWith("Mr."); * ``` * * @param prefix The prefix to check for. - * @return A new `Expression` representing the 'starts with' comparison. + * @returns A new `Expression` representing the 'starts with' comparison. */ startsWith(prefix: string): BooleanExpression; @@ -3813,6 +3856,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if the string value of the current expression starts with the string value of the given prefix expression. * + * @example * ```typescript * // Check if the 'fullName' field starts with the value of the 'firstName' field * field("fullName").startsWith(field("firstName")); @@ -3827,13 +3871,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a string ends with a given postfix. * + * @example * ```typescript * // Check if the 'filename' field ends with ".txt" * field("filename").endsWith(".txt"); * ``` * * @param suffix The postfix to check for. - * @return A new {@link BooleanExpression} representing the 'ends with' comparison. + * @returns A new `BooleanExpression` representing the 'ends with' comparison. */ endsWith(suffix: string): BooleanExpression; /** @@ -3841,43 +3886,47 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if a string ends with a given postfix (represented as an * expression). * + * @example * ```typescript * // Check if the 'url' field ends with the value of the 'extension' field * field("url").endsWith(field("extension")); * ``` * * @param suffix The postfix expression to check for. - * @return A new `Expression` representing the 'ends with' comparison. + * @returns A new `Expression` representing the 'ends with' comparison. */ endsWith(suffix: Expression): BooleanExpression; /** * @beta * Creates an expression that converts a string to lowercase. * + * @example * ```typescript * // Convert the 'name' field to lowercase * field("name").toLower(); * ``` * - * @return A new `Expression` representing the lowercase string. + * @returns A new `Expression` representing the lowercase string. */ toLower(): FunctionExpression; /** * @beta * Creates an expression that converts a string to uppercase. * + * @example * ```typescript * // Convert the 'title' field to uppercase * field("title").toUpper(); * ``` * - * @return A new `Expression` representing the uppercase string. + * @returns A new `Expression` representing the uppercase string. */ toUpper(): FunctionExpression; /** * @beta * Creates an expression that removes leading and trailing characters from a string or byte array. * + * @example * ```typescript * // Trim whitespace from the 'userInput' field * field("userInput").trim(); @@ -3887,7 +3936,7 @@ declare namespace FirebaseFirestore { * ``` * @param valueToTrim Optional This parameter is treated as a set of characters or bytes that will be * trimmed from the input. If not specified, then whitespace will be trimmed. - * @return A new `Expr` representing the trimmed string or byte array. + * @returns A new `Expr` representing the trimmed string or byte array. */ trim( valueToTrim?: string | Expression | Uint8Array | Buffer, @@ -3896,6 +3945,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that concatenates string expressions together. * + * @example * ```typescript * // Combine the 'firstName', " ", and 'lastName' fields into a single string * field("firstName").stringConcat(constant(" "), field("lastName")); @@ -3903,7 +3953,7 @@ declare namespace FirebaseFirestore { * * @param secondString The additional expression or string literal to concatenate. * @param otherStrings Optional additional expressions or string literals to concatenate. - * @return A new `Expression` representing the concatenated string. + * @returns A new `Expression` representing the concatenated string. */ stringConcat( secondString: Expression | string, @@ -3913,48 +3963,52 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that reverses this string or bytes expression. * + * @example * ```typescript * // Reverse the value of the 'myString' field. * field("myString").reverse(); * ``` * - * @return A new {@code Expression} representing the reversed string or bytes. + * @returns A new {@code Expression} representing the reversed string or bytes. */ reverse(): FunctionExpression; /** * @beta * Creates an expression that calculates the length of this string expression in bytes. * + * @example * ```typescript * // Calculate the length of the 'myString' field in bytes. * field("myString").byteLength(); * ``` * - * @return A new {@code Expression} representing the length of the string in bytes. + * @returns A new {@code Expression} representing the length of the string in bytes. */ byteLength(): FunctionExpression; /** * @beta * Creates an expression that computes the ceiling of a numeric value. * + * @example * ```typescript * // Compute the ceiling of the 'price' field. * field("price").ceil(); * ``` * - * @return A new {@code Expression} representing the ceiling of the numeric value. + * @returns A new {@code Expression} representing the ceiling of the numeric value. */ ceil(): FunctionExpression; /** * @beta * Creates an expression that computes the floor of a numeric value. * + * @example * ```typescript * // Compute the floor of the 'price' field. * field("price").floor(); * ``` * - * @return A new {@code Expression} representing the floor of the numeric value. + * @returns A new {@code Expression} representing the floor of the numeric value. */ floor(): FunctionExpression; @@ -3962,12 +4016,13 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that computes the absolute value of a numeric value. * + * @example * ```typescript * // Compute the absolute value of the 'price' field. * field("price").abs(); * ``` * - * @return A new {@code Expr} representing the absolute value of the numeric value. + * @returns A new {@code Expr} representing the absolute value of the numeric value. */ abs(): FunctionExpression; @@ -3975,32 +4030,34 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that computes `e` (Euler's number) raised to the power of this expression's numeric value. * + * @example * ```typescript * // Compute `e` to the power of the 'value' field. * field("value").exp(); * ``` * - * @return A new {@code FunctionExpression} representing `e` raised to the power of the numeric value. + * @returns A new {@code FunctionExpression} representing `e` raised to the power of the numeric value. */ exp(): FunctionExpression; /** * @beta * Creates an aggregation that counts the number of distinct values of the expression or field. * - * @return A new `AggregateFunction` representing the 'count_distinct' aggregation. + * @returns A new `AggregateFunction` representing the 'count_distinct' aggregation. */ countDistinct(): AggregateFunction; /** * @beta * Accesses a value from a map (object) field using the provided key. * + * @example * ```typescript * // Get the 'city' value from the 'address' map field * field("address").mapGet("city"); * ``` * * @param subfield The key to access in the map. - * @return A new `Expression` representing the value associated with the given key in the map. + * @returns A new `Expression` representing the value associated with the given key in the map. */ mapGet(subfield: string): FunctionExpression; /** @@ -4008,24 +4065,26 @@ declare namespace FirebaseFirestore { * Creates an aggregation that counts the number of stage inputs with valid evaluations of the * expression or field. * + * @example * ```typescript * // Count the total number of products * field("productId").count().as("totalProducts"); * ``` * - * @return A new `AggregateFunction` representing the 'count' aggregation. + * @returns A new `AggregateFunction` representing the 'count' aggregation. */ count(): AggregateFunction; /** * @beta * Creates an aggregation that calculates the sum of a numeric field across multiple stage inputs. * + * @example * ```typescript * // Calculate the total revenue from a set of orders * field("orderAmount").sum().as("totalRevenue"); * ``` * - * @return A new `AggregateFunction` representing the 'sum' aggregation. + * @returns A new `AggregateFunction` representing the 'sum' aggregation. */ sum(): AggregateFunction; /** @@ -4033,42 +4092,46 @@ declare namespace FirebaseFirestore { * Creates an aggregation that calculates the average (mean) of a numeric field across multiple * stage inputs. * + * @example * ```typescript * // Calculate the average age of users * field("age").average().as("averageAge"); * ``` * - * @return A new `AggregateFunction` representing the 'average' aggregation. + * @returns A new `AggregateFunction` representing the 'average' aggregation. */ average(): AggregateFunction; /** * @beta * Creates an aggregation that finds the minimum value of a field across multiple stage inputs. * + * @example * ```typescript * // Find the lowest price of all products * field("price").minimum().as("lowestPrice"); * ``` * - * @return A new `AggregateFunction` representing the 'min' aggregation. + * @returns A new `AggregateFunction` representing the 'min' aggregation. */ minimum(): AggregateFunction; /** * @beta * Creates an aggregation that finds the maximum value of a field across multiple stage inputs. * + * @example * ```typescript * // Find the highest score in a leaderboard * field("score").maximum().as("highestScore"); * ``` * - * @return A new `AggregateFunction` representing the 'max' aggregation. + * @returns A new `AggregateFunction` representing the 'max' aggregation. */ maximum(): AggregateFunction; /** * @beta * Creates an expression that returns the larger value between this expression and another expression, based on Firestore's value type ordering. * + * @example * ```typescript * // Returns the larger value between the 'timestamp' field and the current timestamp. * field("timestamp").logicalMaximum(Function.currentTimestamp()); @@ -4076,7 +4139,7 @@ declare namespace FirebaseFirestore { * * @param second The second expression or literal to compare with. * @param others Optional additional expressions or literals to compare with. - * @return A new {@code Expression} representing the logical max operation. + * @returns A new {@code Expression} representing the logical max operation. */ logicalMaximum( second: Expression | unknown, @@ -4086,6 +4149,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that returns the smaller value between this expression and another expression, based on Firestore's value type ordering. * + * @example * ```typescript * // Returns the smaller value between the 'timestamp' field and the current timestamp. * field("timestamp").logicalMinimum(Function.currentTimestamp()); @@ -4093,7 +4157,7 @@ declare namespace FirebaseFirestore { * * @param second The second expression or literal to compare with. * @param others Optional additional expressions or literals to compare with. - * @return A new {@code Expression} representing the logical min operation. + * @returns A new {@code Expression} representing the logical min operation. */ logicalMinimum( second: Expression | unknown, @@ -4103,25 +4167,27 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that calculates the length (number of dimensions) of this Firestore Vector expression. * + * @example * ```typescript * // Get the vector length (dimension) of the field 'embedding'. * field("embedding").vectorLength(); * ``` * - * @return A new {@code Expression} representing the length of the vector. + * @returns A new {@code Expression} representing the length of the vector. */ vectorLength(): FunctionExpression; /** * @beta * Calculates the cosine distance between two vectors. * + * @example * ```typescript * // Calculate the cosine distance between the 'userVector' field and the 'itemVector' field * field("userVector").cosineDistance(field("itemVector")); * ``` * * @param vectorExpression The other vector (represented as an Expression) to compare against. - * @return A new `Expression` representing the cosine distance between the two vectors. + * @returns A new `Expression` representing the cosine distance between the two vectors. */ cosineDistance(vectorExpression: Expression): FunctionExpression; @@ -4129,6 +4195,7 @@ declare namespace FirebaseFirestore { * @beta * Calculates the Cosine distance between two vectors. * + * @example * ```typescript * // Calculate the Cosine distance between the 'embedding' field and a target vector * field("embedding").cosineDistance(FieldValue.vector([0.1, 0.2, 0.3])); @@ -4138,7 +4205,7 @@ declare namespace FirebaseFirestore { * ``` * * @param vector The other vector to compare against, provided as either a `VectorValue` object or a plain `number[]` array. - * @return A new `FunctionExpression` representing the Cosine distance between the two vectors. + * @returns A new `FunctionExpression` representing the Cosine distance between the two vectors. */ cosineDistance(vector: VectorValue | number[]): FunctionExpression; /** @@ -4148,12 +4215,13 @@ declare namespace FirebaseFirestore { * * Both expressions are expected to resolve to an array of numbers (a vector) at runtime. * + * @example * ```typescript * // Calculate the dot product between the 'features' field and the 'targetVector' field. * field("features").dotProduct(field("targetVector")); * ``` * - * @param vectorExpression An {@link Expression} representing the second vector. + * @param vectorExpression An `Expression` representing the second vector. * @returns A new {@link FunctionExpression} representing the dot product of the two vectors. */ dotProduct(vectorExpression: Expression): FunctionExpression; @@ -4162,13 +4230,14 @@ declare namespace FirebaseFirestore { * @beta * Calculates the dot product between two vectors. * + * @example * ```typescript * // Calculate the dot product between a feature vector and a target vector * field("features").dotProduct(FieldValue.vector([0.5, 0.8, 0.2])); * ``` * * @param vector The other vector to calculate the dot product with. This can be a `VectorValue` object or a plain array of numbers. - * @return A new `Expression` representing the dot product between the two vectors. + * @returns A new `Expression` representing the dot product between the two vectors. */ dotProduct(vector: VectorValue | number[]): FunctionExpression; @@ -4176,13 +4245,14 @@ declare namespace FirebaseFirestore { * @beta * Calculates the Euclidean distance between the vector represented by this expression and another vector expression. * + * @example * ```typescript * // Calculate the Euclidean distance between two different vector fields. * field("vectorA").euclideanDistance(field("vectorB")); * ``` * - * @param vectorExpression An {@link Expression} that evaluates to the second vector (an array of numbers) for the distance calculation. - * @return A new {@link FunctionExpression} representing the Euclidean distance between the two vectors. + * @param vectorExpression An `Expression` that evaluates to the second vector (an array of numbers) for the distance calculation. + * @returns A new {@link FunctionExpression} representing the Euclidean distance between the two vectors. */ euclideanDistance(vectorExpression: Expression): FunctionExpression; /** @@ -4191,6 +4261,7 @@ declare namespace FirebaseFirestore { * * The `vector` parameter can be either a `VectorValue` object or a `number[]` (array of numbers). * + * @example * ```typescript * // Calculate the Euclidean distance between the 'location' field and a target location using a VectorValue. * field("location").euclideanDistance(FieldValue.vector([37.7749, -122.4194])); @@ -4200,7 +4271,7 @@ declare namespace FirebaseFirestore { * ``` * * @param vector The other vector (as a `VectorValue` or `number[]`) to compare against. - * @return A new `Expression` representing the Euclidean distance between the two vectors. + * @returns A new `Expression` representing the Euclidean distance between the two vectors. */ euclideanDistance(vector: VectorValue | number[]): FunctionExpression; /** @@ -4208,24 +4279,26 @@ declare namespace FirebaseFirestore { * Creates an expression that interprets this expression as the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC) * and returns a timestamp. * + * @example * ```typescript * // Interpret the 'microseconds' field as microseconds since epoch. * field("microseconds").unixMicrosToTimestamp(); * ``` * - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ unixMicrosToTimestamp(): FunctionExpression; /** * @beta * Creates an expression that converts this timestamp expression to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC). * + * @example * ```typescript * // Convert the 'timestamp' field to microseconds since epoch. * field("timestamp").timestampToUnixMicros(); * ``` * - * @return A new {@code Expression} representing the number of microseconds since epoch. + * @returns A new {@code Expression} representing the number of microseconds since epoch. */ timestampToUnixMicros(): FunctionExpression; /** @@ -4233,24 +4306,26 @@ declare namespace FirebaseFirestore { * Creates an expression that interprets this expression as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) * and returns a timestamp. * + * @example * ```typescript * // Interpret the 'milliseconds' field as milliseconds since epoch. * field("milliseconds").unixMillisToTimestamp(); * ``` * - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ unixMillisToTimestamp(): FunctionExpression; /** * @beta * Creates an expression that converts this timestamp expression to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC). * + * @example * ```typescript * // Convert the 'timestamp' field to milliseconds since epoch. * field("timestamp").timestampToUnixMillis(); * ``` * - * @return A new {@code Expression} representing the number of milliseconds since epoch. + * @returns A new {@code Expression} representing the number of milliseconds since epoch. */ timestampToUnixMillis(): FunctionExpression; /** @@ -4258,30 +4333,33 @@ declare namespace FirebaseFirestore { * Creates an expression that interprets this expression as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) * and returns a timestamp. * + * @example * ```typescript * // Interpret the 'seconds' field as seconds since epoch. * field("seconds").unixSecondsToTimestamp(); * ``` * - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ unixSecondsToTimestamp(): FunctionExpression; /** * @beta * Creates an expression that converts this timestamp expression to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC). * + * @example * ```typescript * // Convert the 'timestamp' field to seconds since epoch. * field("timestamp").timestampToUnixSeconds(); * ``` * - * @return A new {@code Expression} representing the number of seconds since epoch. + * @returns A new {@code Expression} representing the number of seconds since epoch. */ timestampToUnixSeconds(): FunctionExpression; /** * @beta * Creates an expression that adds a specified amount of time to this timestamp expression. * + * @example * ```typescript * // Add some duration determined by field 'unit' and 'amount' to the 'timestamp' field. * field("timestamp").timestampAdd(field("unit"), field("amount")); @@ -4289,13 +4367,14 @@ declare namespace FirebaseFirestore { * * @param unit The expression evaluates to unit of time, must be one of 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'day'. * @param amount The expression evaluates to amount of the unit. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ timestampAdd(unit: Expression, amount: Expression): FunctionExpression; /** * @beta * Creates an expression that adds a specified amount of time to this timestamp expression. * + * @example * ```typescript * // Add 1 day to the 'timestamp' field. * field("timestamp").timestampAdd("day", 1); @@ -4303,7 +4382,7 @@ declare namespace FirebaseFirestore { * * @param unit The unit of time to add (e.g., "day", "hour"). * @param amount The amount of time to add. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ timestampAdd( unit: @@ -4319,6 +4398,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that subtracts a specified amount of time from this timestamp expression. * + * @example * ```typescript * // Subtract some duration determined by field 'unit' and 'amount' from the 'timestamp' field. * field("timestamp").timestampSubtract(field("unit"), field("amount")); @@ -4326,7 +4406,7 @@ declare namespace FirebaseFirestore { * * @param unit The expression evaluates to unit of time, must be one of 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'day'. * @param amount The expression evaluates to amount of the unit. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ timestampSubtract( unit: Expression, @@ -4337,6 +4417,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that subtracts a specified amount of time from this timestamp expression. * + * @example * ```typescript * // Subtract 1 day from the 'timestamp' field. * field("timestamp").timestampSubtract("day", 1); @@ -4344,7 +4425,7 @@ declare namespace FirebaseFirestore { * * @param unit The unit of time to subtract. Supported units are 'microsecond', 'millisecond', 'second', 'minute', 'hour', and 'day'. * @param amount The amount of time to subtract. - * @return A new {@code FunctionExpression} representing the resulting timestamp after subtraction. + * @returns A new {@code FunctionExpression} representing the resulting timestamp after subtraction. */ timestampSubtract( unit: @@ -4360,12 +4441,13 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that returns the document ID from a DocumentReference. * + * @example * ```typescript * // Get the document ID for the current document. * field("__name__").documentId(); * ``` * - * @return A new {@code Expression} representing the documentId operation. + * @returns A new {@code Expression} representing the documentId operation. */ documentId(): FunctionExpression; /** @@ -4392,13 +4474,14 @@ declare namespace FirebaseFirestore { * and returns the element. If the index exceeds the array length, an error is * returned. A negative index, starts from the end. * + * @example * ```typescript * // Return the value in the 'tags' field array at index `1`. * field('tags').arrayGet(1); * ``` * * @param index The index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ arrayGet(index: number): FunctionExpression; /** @@ -4407,6 +4490,7 @@ declare namespace FirebaseFirestore { * and returns the element. If the index exceeds the array length, an error is * returned. A negative index, starts from the end. * + * @example * ```typescript * // Return the value in the tags field array at index specified by field * // 'favoriteTag'. @@ -4414,19 +4498,20 @@ declare namespace FirebaseFirestore { * ``` * * @param indexExpr An Expression evaluating to the index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ arrayGet(indexExpr: Expression): FunctionExpression; /** * @beta * Creates an expression that checks if a given expression produces an error. * + * @example * ```typescript * // Check if the result of a calculation is an error * field("title").arrayContains(1).isError(); * ``` * - * @return A new {@code BooleanExpression} representing the 'isError' check. + * @returns A new {@code BooleanExpression} representing the 'isError' check. */ isError(): BooleanExpression; /** @@ -4434,6 +4519,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the result of the `catchExpr` argument * if there is an error, else return the result of this expression. * + * @example * ```typescript * // Returns the first item in the title field arrays, or returns * // the entire title field if the array is empty or the field is another type. @@ -4442,7 +4528,7 @@ declare namespace FirebaseFirestore { * * @param catchExpr The catch expression that will be evaluated and * returned if this expression produces an error. - * @return A new {@code Expression} representing the 'ifError' operation. + * @returns A new {@code Expression} representing the 'ifError' operation. */ ifError(catchExpr: Expression): FunctionExpression; /** @@ -4450,6 +4536,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `catch` argument if there is an * error, else return the result of this expression. * + * @example * ```typescript * // Returns the first item in the title field arrays, or returns * // "Default Title" @@ -4458,7 +4545,7 @@ declare namespace FirebaseFirestore { * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expression} representing the 'ifError' operation. + * @returns A new {@code Expression} representing the 'ifError' operation. */ ifError(catchValue: unknown): FunctionExpression; /** @@ -4466,12 +4553,13 @@ declare namespace FirebaseFirestore { * Creates an expression that returns `true` if the result of this expression * is absent. Otherwise, returns `false` even if the value is `null`. * + * @example * ```typescript * // Check if the field `value` is absent. * field("value").isAbsent(); * ``` * - * @return A new {@code BooleanExpression} representing the 'isAbsent' check. + * @returns A new {@code BooleanExpression} representing the 'isAbsent' check. */ isAbsent(): BooleanExpression; @@ -4479,6 +4567,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that removes a key from the map produced by evaluating this expression. * + * @example * ```typescript * // Removes the key 'baz' from the input map. * map({foo: 'bar', baz: true}).mapRemove('baz'); @@ -4493,6 +4582,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that removes a key from the map produced by evaluating this expression. * + * @example * ```typescript * // Removes the key 'baz' from the input map. * map({foo: 'bar', baz: true}).mapRemove(constant('baz')); @@ -4509,6 +4599,7 @@ declare namespace FirebaseFirestore { * * The first map in the merge operation is the expression on which `mapMerge` is called. * + * @example * ```typescript * // Merges the map in the 'settings' field with a literal map and a map * // conditionally returned by another expression. @@ -4530,56 +4621,61 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that returns the value of this expression raised to the power of another expression. * + * @example * ```typescript * // Raise the value of the 'base' field to the power of the 'exponent' field. * field("base").pow(field("exponent")); * ``` * * @param exponent The expression to raise this expression to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ pow(exponent: Expression): FunctionExpression; /** * @beta * Creates an expression that returns the value of this expression raised to the power of a constant value. * + * @example * ```typescript * // Raise the value of the 'base' field to the power of 2. * field("base").pow(2); * ``` * * @param exponent The constant value to raise this expression to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ pow(exponent: number): FunctionExpression; /** * @beta * Creates an expression that rounds a numeric value to the nearest whole number. * + * @example * ```typescript * // Round the value of the 'price' field. * field("price").round(); * ``` * - * @return A new `Expression` representing the rounded value. + * @returns A new `Expression` representing the rounded value. */ round(): FunctionExpression; /** * @beta * Creates an expression that rounds a numeric value to the nearest whole number. * + * @example * ```typescript * // Round the value of the 'price' field. * field("price").round(); * ``` * - * @return A new `Expression` representing the rounded value. + * @returns A new `Expression` representing the rounded value. */ round(): FunctionExpression; /** * @beta * Creates an expression that rounds a numeric value to the specified number of decimal places. * + * @example * ```typescript * // Round the value of the 'price' field to two decimal places. * field("price").round(2); @@ -4587,13 +4683,14 @@ declare namespace FirebaseFirestore { * * @param decimalPlaces A constant specifying the rounding precision in decimal places. * - * @return A new `Expr` representing the rounded value. + * @returns A new `Expr` representing the rounded value. */ round(decimalPlaces: number): FunctionExpression; /** * @beta * Creates an expression that rounds a numeric value to the specified number of decimal places. * + * @example * ```typescript * // Round the value of the 'price' field to two decimal places. * field("price").round(constant(2)); @@ -4601,25 +4698,27 @@ declare namespace FirebaseFirestore { * * @param decimalPlaces An expression specifying the rounding precision in decimal places. * - * @return A new `Expr` representing the rounded value. + * @returns A new `Expr` representing the rounded value. */ round(decimalPlaces: Expression): FunctionExpression; /** * @beta * Creates an expression that returns the collection ID from a path. * + * @example * ```typescript * // Get the collection ID from a path. * field("__name__").collectionId(); * ``` * - * @return A new {@code Expression} representing the collectionId operation. + * @returns A new {@code Expression} representing the collectionId operation. */ collectionId(): FunctionExpression; /** * @beta * Creates an expression that calculates the length of a string, array, map, vector, or bytes. * + * @example * ```typescript * // Get the length of the 'name' field. * field("name").length(); @@ -4628,43 +4727,46 @@ declare namespace FirebaseFirestore { * field("cart").length(); * ``` * - * @return A new `Expression` representing the length of the string, array, map, vector, or bytes. + * @returns A new `Expression` representing the length of the string, array, map, vector, or bytes. */ length(): FunctionExpression; /** * @beta * Creates an expression that computes the natural logarithm of a numeric value. * + * @example * ```typescript * // Compute the natural logarithm of the 'value' field. * field("value").ln(); * ``` * - * @return A new {@code Expression} representing the natural logarithm of the numeric value. + * @returns A new {@code Expression} representing the natural logarithm of the numeric value. */ ln(): FunctionExpression; /** * @beta * Creates an expression that computes the square root of a numeric value. * + * @example * ```typescript * // Compute the square root of the 'value' field. * field("value").sqrt(); * ``` * - * @return A new {@code Expression} representing the square root of the numeric value. + * @returns A new {@code Expression} representing the square root of the numeric value. */ sqrt(): FunctionExpression; /** * @beta * Creates an expression that reverses a string. * + * @example * ```typescript * // Reverse the value of the 'myString' field. * field("myString").stringReverse(); * ``` * - * @return A new {@code Expression} representing the reversed string. + * @returns A new {@code Expression} representing the reversed string. */ stringReverse(): FunctionExpression; @@ -4673,6 +4775,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `elseValue` argument if this expression results in an absent value, else * return the result of the this expression evaluation. * + * @example * ```typescript * // Returns the value of the optional field 'optional_field', or returns 'default_value' * // if the field is absent. @@ -4680,7 +4783,7 @@ declare namespace FirebaseFirestore { * ``` * * @param elseValue The value that will be returned if this Expression evaluates to an absent value. - * @return A new [Expression] representing the ifAbsent operation. + * @returns A new [Expression] representing the ifAbsent operation. */ ifAbsent(elseValue: unknown): Expression; @@ -4689,6 +4792,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `elseValue` argument if this expression results in an absent value, else * return the result of this expression evaluation. * + * @example * ```typescript * // Returns the value of the optional field 'optional_field', or if that is * // absent, then returns the value of the field ` @@ -4696,7 +4800,7 @@ declare namespace FirebaseFirestore { * ``` * * @param elseExpression The Expression that will be evaluated if this Expression evaluates to an absent value. - * @return A new [Expression] representing the ifAbsent operation. + * @returns A new [Expression] representing the ifAbsent operation. */ ifAbsent(elseExpression: unknown): Expression; @@ -4706,13 +4810,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that joins the elements of an array into a string. * + * @example * ```typescript * // Join the elements of the 'tags' field with the delimiter from the 'separator' field. * field("tags").join(field("separator")) * ``` * * @param delimiterExpression The expression that evaluates to the delimiter string. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ join(delimiterExpression: Expression): Expression; @@ -4720,13 +4825,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that joins the elements of an array field into a string. * + * @example * ```typescript * // Join the elements of the 'tags' field with a comma and space. * field("tags").join(", ") * ``` * * @param delimiter The string to use as a delimiter. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ join(delimiter: string): Expression; @@ -4736,12 +4842,13 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that computes the base-10 logarithm of a numeric value. * + * @example * ```typescript * // Compute the base-10 logarithm of the 'value' field. * field("value").log10(); * ``` * - * @return A new {@code Expr} representing the base-10 logarithm of the numeric value. + * @returns A new {@code Expr} representing the base-10 logarithm of the numeric value. */ log10(): FunctionExpression; @@ -4749,12 +4856,13 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that computes the sum of the elements in an array. * + * @example * ```typescript * // Compute the sum of the elements in the 'scores' field. * field("scores").arraySum(); * ``` * - * @return A new {@code Expr} representing the sum of the elements in the array. + * @returns A new {@code Expr} representing the sum of the elements in the array. */ arraySum(): FunctionExpression; /** @@ -4768,7 +4876,7 @@ declare namespace FirebaseFirestore { * field('scoresCsv').split(',') * ``` * - * @return A new {@code Expression} representing the split function. + * @returns A new {@code Expression} representing the split function. */ split(delimiter: string): FunctionExpression; @@ -4783,7 +4891,7 @@ declare namespace FirebaseFirestore { * field('scores').split(conditional(field('format').equal('csv'), constant(','), constant(':')) * ``` * - * @return A new {@code Expression} representing the split function. + * @returns A new {@code Expression} representing the split function. */ split(delimiter: Expression): FunctionExpression; /** @@ -4798,7 +4906,7 @@ declare namespace FirebaseFirestore { * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ timestampTruncate( granularity: TimeGranularity, @@ -4817,7 +4925,7 @@ declare namespace FirebaseFirestore { * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ timestampTruncate( granularity: Expression, @@ -4834,35 +4942,37 @@ declare namespace FirebaseFirestore { * field('title').type() * ``` * - * @return A new {Expression} representing the data type. + * @returns A new {Expression} representing the data type. */ type(): FunctionExpression; // TODO(new-expression): Add new expression method declarations above this line /** * @beta - * Creates an {@link Ordering} that sorts documents in ascending order based on this expression. + * Creates an `Ordering` that sorts documents in ascending order based on this expression. * + * @example * ```typescript * // Sort documents by the 'name' field in ascending order * pipeline().collection("users") * .sort(field("name").ascending()); * ``` * - * @return A new `Ordering` for ascending sorting. + * @returns A new `Ordering` for ascending sorting. */ ascending(): Ordering; /** * @beta - * Creates an {@link Ordering} that sorts documents in descending order based on this expression. + * Creates an `Ordering` that sorts documents in descending order based on this expression. * + * @example * ```typescript * // Sort documents by the 'createdAt' field in descending order * pipeline().collection("users") * .sort(field("createdAt").descending()); * ``` * - * @return A new `Ordering` for descending sorting. + * @returns A new `Ordering` for descending sorting. */ descending(): Ordering; /** @@ -4872,6 +4982,7 @@ declare namespace FirebaseFirestore { * Aliases are useful for renaming fields in the output of a stage or for giving meaningful * names to calculated values. * + * @example * ```typescript * // Calculate the total price and assign it the alias "totalPrice" and add it to the output. * pipeline().collection("items") @@ -4879,7 +4990,7 @@ declare namespace FirebaseFirestore { * ``` * * @param name The alias to assign to this expression. - * @return A new {@link AliasedExpression} that wraps this + * @returns A new `AliasedExpression` that wraps this * expression and associates it with the provided alias. */ as(name: string): AliasedExpression; @@ -4954,6 +5065,7 @@ declare namespace FirebaseFirestore { * Assigns an alias to this AggregateFunction. The alias specifies the name that * the aggregated value will have in the output document. * + * @example * ```typescript * // Calculate the average price of all items and assign it the alias "averagePrice". * pipeline().collection("items") @@ -4961,7 +5073,7 @@ declare namespace FirebaseFirestore { * ``` * * @param name The alias to assign to this AggregateFunction. - * @return A new {@link AliasedAggregate} that wraps this + * @returns A new `AliasedAggregate` that wraps this * AggregateFunction and associates it with the provided alias. */ as(name: string): AliasedAggregate; @@ -4969,13 +5081,13 @@ declare namespace FirebaseFirestore { /** * @beta - * Represents an {@link AggregateFunction} that has been assigned an alias. + * Represents an `AggregateFunction` that has been assigned an alias. * This class is used to associate an aggregate result with a name. */ export class AliasedAggregate { /** * @beta - * The underlying {@link AggregateFunction} that this aliased aggregate wraps. + * The underlying `AggregateFunction` that this aliased aggregate wraps. * @internal */ readonly _aggregate: AggregateFunction; @@ -4992,7 +5104,7 @@ declare namespace FirebaseFirestore { * @beta * Represents an expression that has been assigned an alias using the `.as()` method. * - * This class wraps an existing {@link Expression} and associates it with a user-defined alias, + * This class wraps an existing `Expression` and associates it with a user-defined alias, * allowing the expression's result to be referred to by name in the output * of a Firestore pipeline query. */ @@ -5006,7 +5118,7 @@ declare namespace FirebaseFirestore { /** * @beta - * Specifies that this class is selectable, meaning it contains an {@link Expression} and an alias, + * Specifies that this class is selectable, meaning it contains an `Expression` and an alias, * and can be provided to the Select stage of a pipeline. */ selectable: true; @@ -5028,10 +5140,10 @@ declare namespace FirebaseFirestore { /** * @beta - * Represents a reference to a field within a Firestore document or an output from a {@link Pipeline} stage. + * Represents a reference to a field within a Firestore document or an output from a `Pipeline` stage. * - * This class extends {@link Expression}. It is a type of expression that can be evaluated - * within Firestore Pipelines. It also implements {@link Selectable}, + * This class extends `Expression`. It is a type of expression that can be evaluated + * within Firestore Pipelines. It also implements `Selectable`, * meaning instances of `Field` can be used to specify fields for selection in the {@link Pipeline.select} stage. * * `Field` instances are fundamental for constructing expressions that access document field values, @@ -5045,7 +5157,7 @@ declare namespace FirebaseFirestore { readonly expressionType: ExpressionType; /** * @beta - * Specifies that this class is selectable, meaning it contains an {@link Expression} and an alias, + * Specifies that this class is selectable, meaning it contains an `Expression` and an alias, * and can be provided to the Select stage of a pipeline. */ selectable: true; @@ -5075,7 +5187,7 @@ declare namespace FirebaseFirestore { * @internal * Self-referential getter that returns this. * - * @returns This {@link Field} object. + * @returns This `Field` object. */ get _expr(): Expression; } @@ -5086,6 +5198,7 @@ declare namespace FirebaseFirestore { * The path can be a simple field name (e.g., "name") or a dot-separated path to a nested field * (e.g., "address.city"). * + * @example * ```typescript * // Create a Field instance for the 'title' field * const titleField = field("title"); @@ -5095,7 +5208,7 @@ declare namespace FirebaseFirestore { * ``` * * @param name The path to the field. - * @return A new {@code Field} instance representing the specified field. + * @returns A new {@code Field} instance representing the specified field. */ export function field(name: string): Field; /** @@ -5103,7 +5216,7 @@ declare namespace FirebaseFirestore { * Creates a new Field instance from a given FieldPath. * * @param path The FieldPath to convert into a Field. - * @returns A new {@link Field} instance representing the specified path. + * @returns A new `Field` instance representing the specified path. */ export function field(path: FieldPath): Field; @@ -5114,6 +5227,7 @@ declare namespace FirebaseFirestore { * * Instances of `Constant` are typically created via the top-level `constant()` function. * + * @example * ```typescript * // Create a Constant instance for the number 10 * const ten = constant(10); @@ -5130,7 +5244,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a number value. * * @param value The number value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: number): Expression; /** @@ -5138,7 +5252,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a string value. * * @param value The string value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: string): Expression; /** @@ -5146,7 +5260,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a boolean value. * * @param value The boolean value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: boolean): BooleanExpression; /** @@ -5154,7 +5268,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a null value. * * @param value The null value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: null): Expression; /** @@ -5162,7 +5276,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a GeoPoint value. * * @param value The GeoPoint value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: GeoPoint): Expression; /** @@ -5170,7 +5284,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a Timestamp value. * * @param value The Timestamp value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: Timestamp): Expression; /** @@ -5178,7 +5292,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a Date value. * * @param value The Date value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: Date): Expression; /** @@ -5186,7 +5300,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a Buffer | Uint8Array value. * * @param value The Buffer | Uint8Array value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: Buffer | Uint8Array): Expression; /** @@ -5194,7 +5308,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a DocumentReference value. * * @param value The DocumentReference value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: DocumentReference): Expression; /** @@ -5202,7 +5316,7 @@ declare namespace FirebaseFirestore { * Creates an `Expression` instance for a VectorValue value. * * @param value The VectorValue value. - * @return A new `Expression` instance. + * @returns A new `Expression` instance. */ export function constant(value: VectorValue): Expression; @@ -5210,14 +5324,15 @@ declare namespace FirebaseFirestore { * @beta * Represents an expression that encapsulates a function call within the Firestore Pipelines. * - * `FunctionExpression` extends {@link Expression} and is used to build complex queries and transformations + * `FunctionExpression` extends `Expression` and is used to build complex queries and transformations * by applying various functions (e.g., `and`, `equal`, `ceil`) to fields or other expressions. * * You typically do not instantiate `FunctionExpression` directly. Instead, use the provided - * top-level functions (like {@link and}, {@link equal}, {@link ceil}) or methods available - * on {@link Expression} instances (e.g., {@link Expression#equal}, {@link Expression#lessThan}) to construct + * top-level functions (like `and`, `equal`, {@link ceil}) or methods available + * on `Expression` instances (e.g., {@link Expression#equal}, {@link Expression#lessThan}) to construct * `FunctionExpression` instances. * + * @example * ```typescript * // Example of creating a FunctionExpression indirectly using helper functions: * const priceGreaterThan10 = field("price").greaterThan(10); @@ -5258,12 +5373,13 @@ declare namespace FirebaseFirestore { * Creates an aggregation that finds the count of input documents satisfying * this boolean expression. * + * @example * ```typescript * // Find the count of documents with a score greater than 90 * field("score").greaterThan(90).countIf().as("highestScore"); * ``` * - * @return A new `AggregateFunction` representing the 'countIf' aggregation. + * @returns A new `AggregateFunction` representing the 'countIf' aggregation. */ countIf(): AggregateFunction; @@ -5271,12 +5387,13 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that negates this boolean expression. * + * @example * ```typescript * // Find documents where the 'tags' field does not contain 'completed' * field("tags").arrayContains("completed").not(); * ``` * - * @return A new {@code Expression} representing the negated filter condition. + * @returns A new {@code Expression} representing the negated filter condition. */ not(): BooleanExpression; @@ -5286,6 +5403,7 @@ declare namespace FirebaseFirestore { * if `this` expression evaluates to `true`, * or evaluates to the 'else' expression if `this` expressions evaluates `false`. * + * @example * ```typescript * // If 'age' is greater than 18, return "Adult"; otherwise, return "Minor". * field("age").greaterThanOrEqual(18).conditional(constant("Adult"), constant("Minor")); @@ -5293,7 +5411,7 @@ declare namespace FirebaseFirestore { * * @param thenExpr The expression to evaluate if the condition is true. * @param elseExpr The expression to evaluate if the condition is false. - * @return A new {@code Expr} representing the conditional expression. + * @returns A new {@code Expr} representing the conditional expression. */ conditional( thenExpr: Expression, @@ -5306,6 +5424,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `catch` argument if there is an * error, else return the result of this expression. * + * @example * ```typescript * // Create an expression that protects against a divide by zero error * // but always returns a boolean expression. @@ -5314,7 +5433,7 @@ declare namespace FirebaseFirestore { * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new {@code Expr} representing the 'ifError' operation. */ ifError(catchValue: BooleanExpression): BooleanExpression; @@ -5324,6 +5443,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `catch` argument if there is an * error, else return the result of this expression. * + * @example * ```typescript * // Create an expression that protects against a divide by zero error * // but always returns a boolean expression. @@ -5332,7 +5452,7 @@ declare namespace FirebaseFirestore { * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new {@code Expr} representing the 'ifError' operation. */ ifError(catchValue: boolean): BooleanExpression; @@ -5342,6 +5462,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `catch` argument if there is an * error, else return the result of this expression. * + * @example * ```typescript * // Create an expression that protects against a divide by zero error. * constant(50).divide('length').gt(1).ifError(constant(0)); @@ -5349,7 +5470,7 @@ declare namespace FirebaseFirestore { * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new {@code Expr} representing the 'ifError' operation. */ ifError(catchValue: Expression): FunctionExpression; @@ -5359,6 +5480,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `catch` argument if there is an * error, else return the result of this expression. * + * @example * ```typescript * // Create an expression that protects against a divide by zero error. * constant(50).divide('length').gt(1).ifError(0); @@ -5366,7 +5488,7 @@ declare namespace FirebaseFirestore { * * @param catchValue The value that will be returned if this expression * produces an error. - * @return A new {@code Expr} representing the 'ifError' operation. + * @returns A new {@code Expr} representing the 'ifError' operation. */ ifError(catchValue: unknown): FunctionExpression; } @@ -5375,6 +5497,7 @@ declare namespace FirebaseFirestore { * Creates an aggregation that counts the number of stage inputs where the provided * boolean expression evaluates to true. * + * @example * ```typescript * // Count the number of documents where 'is_active' field equals true * countIf(field("is_active").equal(true)).as("numActiveDocuments"); @@ -5390,6 +5513,7 @@ declare namespace FirebaseFirestore { * and return the element. If the index exceeds the array length, an error is * returned. A negative index, starts from the end. * + * @example * ```typescript * // Return the value in the tags field array at index 1. * arrayGet('tags', 1); @@ -5397,7 +5521,7 @@ declare namespace FirebaseFirestore { * * @param arrayField The name of the array field. * @param index The index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ export function arrayGet( arrayField: string, @@ -5409,6 +5533,7 @@ declare namespace FirebaseFirestore { * and return the element. If the index exceeds the array length, an error is * returned. A negative index, starts from the end. * + * @example * ```typescript * // Return the value in the tags field array at index specified by field * // 'favoriteTag'. @@ -5417,7 +5542,7 @@ declare namespace FirebaseFirestore { * * @param arrayField The name of the array field. * @param indexExpr An Expression evaluating to the index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ export function arrayGet( arrayField: string, @@ -5429,6 +5554,7 @@ declare namespace FirebaseFirestore { * and return the element. If the index exceeds the array length, an error is * returned. A negative index, starts from the end. * + * @example * ```typescript * // Return the value in the tags field array at index 1. * arrayGet(field('tags'), 1); @@ -5436,7 +5562,7 @@ declare namespace FirebaseFirestore { * * @param arrayExpression An Expression evaluating to an array. * @param index The index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ export function arrayGet( arrayExpression: Expression, @@ -5448,6 +5574,7 @@ declare namespace FirebaseFirestore { * and return the element. If the index exceeds the array length, an error is * returned. A negative index, starts from the end. * + * @example * ```typescript * // Return the value in the tags field array at index specified by field * // 'favoriteTag'. @@ -5456,7 +5583,7 @@ declare namespace FirebaseFirestore { * * @param arrayExpression An Expression evaluating to an array. * @param indexExpr An Expression evaluating to the index of the element to return. - * @return A new Expression representing the 'arrayGet' operation. + * @returns A new Expression representing the 'arrayGet' operation. */ export function arrayGet( arrayExpression: Expression, @@ -5466,13 +5593,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a given expression produces an error. * + * @example * ```typescript * // Check if the result of a calculation is an error * isError(field("title").arrayContains(1)); * ``` * * @param value The expression to check. - * @return A new {@code BooleanExpression} representing the 'isError' check. + * @returns A new {@code BooleanExpression} representing the 'isError' check. */ export function isError(value: Expression): BooleanExpression; /** @@ -5483,6 +5611,7 @@ declare namespace FirebaseFirestore { * * This overload is useful when a BooleanExpression is required. * + * @example * ```typescript * // Create an expression that protects against a divide by zero error * // but always returns a boolean expression. @@ -5492,7 +5621,7 @@ declare namespace FirebaseFirestore { * @param tryExpr The try expression. * @param catchExpr The catch expression that will be evaluated and * returned if the tryExpr produces an error. - * @return A new {@code BooleanExpression} representing the 'ifError' operation. + * @returns A new {@code BooleanExpression} representing the 'ifError' operation. */ export function ifError( tryExpr: BooleanExpression, @@ -5505,6 +5634,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `catch` argument if there is an * error, else return the result of the `try` argument evaluation. * + * @example * ```typescript * // Returns the first item in the title field arrays, or returns * // the entire title field if the array is empty or the field is another type. @@ -5514,7 +5644,7 @@ declare namespace FirebaseFirestore { * @param tryExpr The try expression. * @param catchExpr The catch expression that will be evaluated and * returned if the tryExpr produces an error. - * @return A new {@code Expression} representing the 'ifError' operation. + * @returns A new {@code Expression} representing the 'ifError' operation. */ export function ifError( tryExpr: Expression, @@ -5527,6 +5657,7 @@ declare namespace FirebaseFirestore { * Creates an expression that returns the `catch` argument if there is an * error, else return the result of the `try` argument evaluation. * + * @example * ```typescript * // Returns the first item in the title field arrays, or returns * // "Default Title" @@ -5536,7 +5667,7 @@ declare namespace FirebaseFirestore { * @param tryExpr The try expression. * @param catchValue The value that will be returned if the tryExpr produces an * error. - * @return A new {@code Expression} representing the 'ifError' operation. + * @returns A new {@code Expression} representing the 'ifError' operation. */ export function ifError( tryExpr: Expression, @@ -5548,13 +5679,14 @@ declare namespace FirebaseFirestore { * Creates an expression that returns `true` if a value is absent. Otherwise, * returns `false` even if the value is `null`. * + * @example * ```typescript * // Check if the field `value` is absent. * isAbsent(field("value")); * ``` * * @param value The expression to check. - * @return A new {@code Expression} representing the 'isAbsent' check. + * @returns A new {@code Expression} representing the 'isAbsent' check. */ export function isAbsent(value: Expression): BooleanExpression; /** @@ -5562,13 +5694,14 @@ declare namespace FirebaseFirestore { * Creates an expression that returns `true` if a field is absent. Otherwise, * returns `false` even if the field value is `null`. * + * @example * ```typescript * // Check if the field `value` is absent. * isAbsent("value"); * ``` * * @param field The field to check. - * @return A new {@code Expression} representing the 'isAbsent' check. + * @returns A new {@code Expression} representing the 'isAbsent' check. */ export function isAbsent(field: string): BooleanExpression; @@ -5593,6 +5726,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that removes a key from the map produced by evaluating another expression. * + * @example * ```typescript * // Removes the key 'baz' from the input map. * mapRemove(map({foo: 'bar', baz: true}), 'baz'); @@ -5611,6 +5745,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that removes a key from the map at the specified field name. * + * @example * ```typescript * // Removes the key 'city' field from the map in the address field of the input document. * mapRemove('address', constant('city')); @@ -5633,6 +5768,7 @@ declare namespace FirebaseFirestore { * 1. An expression that evaluates to a map. * 2. An expression that evaluates to the string key to be removed from the map. * + * @example * ```typescript * // Removes the key 'baz' from the input map. * mapRemove(map({foo: 'bar', baz: true}), constant('baz')); @@ -5693,13 +5829,14 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that extracts the document ID from a document reference. * + * @example * ```typescript * // Get the document ID from a document reference. * documentId(field("__name__")); * ``` * * @param documentPathExpr An expression evaluating to a document path. - * @return A new {@code FunctionExpression} representing the document ID as a string. + * @returns A new {@code FunctionExpression} representing the document ID as a string. */ export function documentId( documentPathExpr: Expression, @@ -5710,12 +5847,13 @@ declare namespace FirebaseFirestore { * * Creates an expression that returns the document ID from a path. * + * @example * ```typescript * // Get the document ID from a path. * documentId(myDocumentReference); * ``` * - * @return A new {@code Expr} representing the documentId operation. + * @returns A new {@code Expr} representing the documentId operation. */ export function documentId( documentPath: string | DocumentReference, @@ -5725,12 +5863,13 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that returns the document ID from a path. * + * @example * ```typescript * // Get the document ID from a path. * documentId(field("__path__")); * ``` * - * @return A new {@code Expression} representing the documentId operation. + * @returns A new {@code Expression} representing the documentId operation. */ export function documentId( documentPathExpr: Expression, @@ -5779,6 +5918,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that returns a substring of a string or byte array. * + * @example * ```typescript * // Get a substring of the 'myString' field from index 0 with length 5. * substring(field("myString"), 0, 5); @@ -5787,7 +5927,7 @@ declare namespace FirebaseFirestore { * @param input An expression returning a string or byte array from which to extract the substring. * @param position An expression that returns the 0-based starting index of the substring. * @param length Optional. An expression that returns the length of the substring. If omitted, the substring extends to the end of the input. - * @return A new {@code FunctionExpression} representing the substring operation. + * @returns A new {@code FunctionExpression} representing the substring operation. */ export function substring( input: Expression, @@ -5801,6 +5941,7 @@ declare namespace FirebaseFirestore { * * This function supports adding multiple values. For example, `add(a, b, c)` is equivalent to `add(add(a, b), c)`. * + * @example * ```typescript * // Add the value of the 'quantity' field and the 'reserve' field. * add(field("quantity"), field("reserve")); @@ -5812,7 +5953,7 @@ declare namespace FirebaseFirestore { * @param first The initial numeric expression or literal value. * @param second The second numeric expression or literal value to add. * @param others Optional: Additional numeric expressions or literal values to add. - * @return A new {@code FunctionExpression} representing the sum of all provided arguments. + * @returns A new {@code FunctionExpression} representing the sum of all provided arguments. */ export function add( first: Expression, @@ -5824,6 +5965,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that computes the sum of a field's value and one or more other expressions or literals. * + * @example * ```typescript * // Add the value of the 'quantity' field to the value of the 'reserve' field. * add("quantity", field("reserve")); @@ -5838,7 +5980,7 @@ declare namespace FirebaseFirestore { * @param fieldName The name of the field whose value will be the first operand in the addition. * @param second The second operand, which can be an {@code Expression} or a literal value. * @param others Optional additional operands, each of which can be an {@code Expression} or a literal value. - * @return A new {@code Expression} representing the addition operation. + * @returns A new {@code Expression} representing the addition operation. */ export function add( fieldName: string, @@ -5849,6 +5991,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that subtracts two expressions. * + * @example * ```typescript * // Subtract the 'discount' field from the 'price' field * subtract(field("price"), field("discount")); @@ -5856,7 +5999,7 @@ declare namespace FirebaseFirestore { * * @param minuend The expression to subtract from. * @param subtrahend The expression to subtract. - * @return A new {@code Expression} representing the subtraction operation. + * @returns A new {@code Expression} representing the subtraction operation. */ export function subtract( minuend: Expression, @@ -5867,6 +6010,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that subtracts one value from another. * + * @example * ```typescript * // Subtract the constant value 2 from the 'value' field * subtract(field("value"), 2); @@ -5874,7 +6018,7 @@ declare namespace FirebaseFirestore { * * @param minuend The expression to subtract from. * @param subtrahend The value to subtract. - * @return A new {@code Expression} representing the subtraction operation. + * @returns A new {@code Expression} representing the subtraction operation. */ export function subtract( minuend: Expression, @@ -5884,6 +6028,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that subtracts an expression from a field's value. * + * @example * ```typescript * // Subtract the 'discount' field from the 'price' field * subtract("price", field("discount")); @@ -5891,7 +6036,7 @@ declare namespace FirebaseFirestore { * * @param minuendFieldName The field name to subtract from. * @param subtrahend The expression to subtract. - * @return A new {@code Expression} representing the subtraction operation. + * @returns A new {@code Expression} representing the subtraction operation. */ export function subtract( minuendFieldName: string, @@ -5903,6 +6048,7 @@ declare namespace FirebaseFirestore { * Creates an expression that subtracts a value from a field's value. * * + * @example * ```typescript * // Subtract 20 from the value of the 'total' field * subtract("total", 20); @@ -5910,7 +6056,7 @@ declare namespace FirebaseFirestore { * * @param minuendFieldName The name of the field to subtract from. * @param subtrahend The value to subtract. - * @return A new {@code Expression} representing the subtraction operation. + * @returns A new {@code Expression} representing the subtraction operation. */ export function subtract( minuendFieldName: string, @@ -5921,6 +6067,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that multiplies two or more values together. * + * @example * ```typescript * // Multiply the 'quantity' field by the 'price' field * multiply(field("quantity"), field("price")); @@ -5932,7 +6079,7 @@ declare namespace FirebaseFirestore { * @param first The first expression to multiply. * @param second The second expression or literal to multiply. * @param others Optional additional expressions or literals to multiply. - * @return A new {@code FunctionExpression} representing the multiplication operation. + * @returns A new {@code FunctionExpression} representing the multiplication operation. */ export function multiply( first: Expression, @@ -5944,15 +6091,16 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that multiplies a field's value by one or more other expressions or literal values. * + * @example * ```typescript * // Multiply the 'quantity' field by the 'price' field * multiply("quantity", field("price")); * ``` * * @param fieldName The name of the field whose value will be the initial operand of the multiplication. - * @param second The second operand, which can be an {@link Expression} or a literal value, to be multiplied. - * @param others Optional additional operands ({@link Expression} or literal values) to be included in the multiplication. - * @return A new {@link FunctionExpression} representing the multiplication operation. + * @param second The second operand, which can be an `Expression` or a literal value, to be multiplied. + * @param others Optional additional operands (`Expression` or literal values) to be included in the multiplication. + * @returns A new {@link FunctionExpression} representing the multiplication operation. */ export function multiply( fieldName: string, @@ -5963,6 +6111,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that divides two expressions. * + * @example * ```typescript * // Divide the 'total' field by the 'count' field * divide(field("total"), field("count")); @@ -5970,7 +6119,7 @@ declare namespace FirebaseFirestore { * * @param dividend The expression to be divided. * @param divisor The expression to divide by. - * @return A new {@code Expression} representing the division operation. + * @returns A new {@code Expression} representing the division operation. */ export function divide( dividend: Expression, @@ -5980,6 +6129,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that divides an expression by a constant value. * + * @example * ```typescript * // Divide the 'value' field by 10 * divide(field("value"), 10); @@ -5987,7 +6137,7 @@ declare namespace FirebaseFirestore { * * @param dividend The expression to be divided. * @param divisor The constant value to divide by. - * @return A new {@code Expression} representing the division operation. + * @returns A new {@code Expression} representing the division operation. */ export function divide( dividend: Expression, @@ -5997,6 +6147,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that divides a field's value by an expression. * + * @example * ```typescript * // Divide the 'total' field by the 'count' field * divide("total", field("count")); @@ -6004,7 +6155,7 @@ declare namespace FirebaseFirestore { * * @param dividend The field name to be divided. * @param divisor The expression to divide by. - * @return A new {@code Expression} representing the division operation. + * @returns A new {@code Expression} representing the division operation. */ export function divide( dividend: string, @@ -6014,6 +6165,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that divides a field's value by a constant value. * + * @example * ```typescript * // Divide the 'value' field by 10 * divide("value", 10); @@ -6021,7 +6173,7 @@ declare namespace FirebaseFirestore { * * @param dividend The field name to be divided. * @param divisor The constant value to divide by. - * @return A new {@code Expression} representing the division operation. + * @returns A new {@code Expression} representing the division operation. */ export function divide( dividend: string, @@ -6031,6 +6183,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that calculates the modulo (remainder) of dividing two expressions. * + * @example * ```typescript * // Calculate the remainder of dividing 'field1' by 'field2'. * mod(field("field1"), field("field2")); @@ -6038,7 +6191,7 @@ declare namespace FirebaseFirestore { * * @param left The dividend expression. * @param right The divisor expression. - * @return A new {@code Expression} representing the modulo operation. + * @returns A new {@code Expression} representing the modulo operation. */ export function mod( left: Expression, @@ -6048,6 +6201,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that calculates the modulo (remainder) of dividing an expression by a constant. * + * @example * ```typescript * // Calculate the remainder of dividing 'field1' by 5. * mod(field("field1"), 5); @@ -6055,7 +6209,7 @@ declare namespace FirebaseFirestore { * * @param expression The dividend expression. * @param value The divisor constant. - * @return A new {@code Expression} representing the modulo operation. + * @returns A new {@code Expression} representing the modulo operation. */ export function mod( expression: Expression, @@ -6065,6 +6219,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that calculates the modulo (remainder) of dividing a field's value by an expression. * + * @example * ```typescript * // Calculate the remainder of dividing 'field1' by 'field2'. * mod("field1", field("field2")); @@ -6072,7 +6227,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The dividend field name. * @param expression The divisor expression. - * @return A new {@code Expression} representing the modulo operation. + * @returns A new {@code Expression} representing the modulo operation. */ export function mod( fieldName: string, @@ -6082,6 +6237,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that calculates the modulo (remainder) of dividing a field's value by a constant. * + * @example * ```typescript * // Calculate the remainder of dividing 'field1' by 5. * mod("field1", 5); @@ -6089,7 +6245,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The dividend field name. * @param value The divisor constant. - * @return A new {@code Expression} representing the modulo operation. + * @returns A new {@code Expression} representing the modulo operation. */ export function mod(fieldName: string, value: unknown): FunctionExpression; @@ -6099,6 +6255,7 @@ declare namespace FirebaseFirestore { * The keys of the object become the field names in the Firestore map, and the values become the field values. * Values can be literal values or other expressions (e.g., `Field.of()`). * + * @example * ```typescript * // Create a map from the input object, where 'foo' is a literal string and 'baz' references the value * // of the 'baz' field from the document currently being processed by the pipeline. @@ -6114,13 +6271,14 @@ declare namespace FirebaseFirestore { * Creates an expression that creates a Firestore array value from a given JavaScript array. * Array values can be literals or other expressions (e.g., `Field.of()`). * + * @example * ```typescript * // Create an array value from the input array and reference the 'baz' field value from the input document. * array(['bar', Field.of('baz')]).as('foo'); * ``` * * @param elements The input array to evaluate in the expression. - * @return A new {@code Expression} representing the array function. + * @returns A new {@code Expression} representing the array function. */ export function array(elements: unknown[]): FunctionExpression; @@ -6128,6 +6286,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if two expressions are equal. * + * @example * ```typescript * // Check if the 'age' field is equal to an expression * equal(field("age"), field("minAge").add(10)); @@ -6135,7 +6294,7 @@ declare namespace FirebaseFirestore { * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `BooleanExpression` representing the equality comparison. + * @returns A new `BooleanExpression` representing the equality comparison. */ export function equal( left: Expression, @@ -6145,6 +6304,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if an expression is equal to a constant value. * + * @example * ```typescript * // Check if the 'age' field is equal to 21 * equal(field("age"), 21); @@ -6152,7 +6312,7 @@ declare namespace FirebaseFirestore { * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ export function equal( expression: Expression, @@ -6163,6 +6323,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is equal to another expression. * + * @example * ```typescript * // Check if the 'age' field is equal to the 'limit' field * equal("age", field("limit")); @@ -6170,7 +6331,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field to compare. * @param expression The expression to compare the field's value against. - * @return A new `BooleanExpression` representing the equality comparison. + * @returns A new `BooleanExpression` representing the equality comparison. */ export function equal( fieldName: string, @@ -6180,6 +6341,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is equal to a constant value. * + * @example * ```typescript * // Check if the 'city' field is equal to string constant "London" * equal("city", "London"); @@ -6187,13 +6349,14 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the equality comparison. + * @returns A new `Expression` representing the equality comparison. */ export function equal(fieldName: string, value: unknown): BooleanExpression; /** * @beta * Creates an expression that checks if two expressions are not equal. * + * @example * ```typescript * // Check if the 'status' field is not equal to field 'finalState' * notEqual(field("status"), field("finalState")); @@ -6201,7 +6364,7 @@ declare namespace FirebaseFirestore { * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ export function notEqual( left: Expression, @@ -6211,6 +6374,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if an expression is not equal to a constant value. * + * @example * ```typescript * // Check if the 'status' field is not equal to "completed" * notEqual(field("status"), "completed"); @@ -6218,7 +6382,7 @@ declare namespace FirebaseFirestore { * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ export function notEqual( expression: Expression, @@ -6229,6 +6393,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is not equal to an expression. * + * @example * ```typescript * // Check if the 'status' field is not equal to the value of 'expectedStatus' * notEqual("status", field("expectedStatus")); @@ -6236,7 +6401,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param expression The expression to compare to. - * @return A new {@link BooleanExpression} representing the inequality comparison. + * @returns A new `BooleanExpression` representing the inequality comparison. */ export function notEqual( fieldName: string, @@ -6246,6 +6411,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is not equal to a constant value. * + * @example * ```typescript * // Check if the 'country' field is not equal to "USA" * notEqual("country", "USA"); @@ -6253,7 +6419,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the inequality comparison. + * @returns A new `Expression` representing the inequality comparison. */ export function notEqual( fieldName: string, @@ -6263,6 +6429,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if the first expression is less than the second expression. * + * @example * ```typescript * // Check if the 'age' field is less than 30 * lessThan(field("age"), field("limit")); @@ -6270,7 +6437,7 @@ declare namespace FirebaseFirestore { * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ export function lessThan( left: Expression, @@ -6280,6 +6447,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if an expression is less than a constant value. * + * @example * ```typescript * // Check if the 'age' field is less than 30 * lessThan(field("age"), 30); @@ -6287,7 +6455,7 @@ declare namespace FirebaseFirestore { * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ export function lessThan( expression: Expression, @@ -6298,6 +6466,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is less than an expression. * + * @example * ```typescript * // Check if the 'age' field is less than the 'limit' field * lessThan("age", field("limit")); @@ -6305,7 +6474,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param expression The expression to compare to. - * @return A new `BooleanExpression` representing the less than comparison. + * @returns A new `BooleanExpression` representing the less than comparison. */ export function lessThan( fieldName: string, @@ -6315,6 +6484,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is less than a constant value. * + * @example * ```typescript * // Check if the 'price' field is less than 50 * lessThan("price", 50); @@ -6322,7 +6492,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the less than comparison. + * @returns A new `Expression` representing the less than comparison. */ export function lessThan( fieldName: string, @@ -6333,6 +6503,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if the first expression is less than or equal to the second * expression. * + * @example * ```typescript * // Check if the 'quantity' field is less than or equal to 20 * lessThanOrEqual(field("quantity"), field("limit")); @@ -6340,7 +6511,7 @@ declare namespace FirebaseFirestore { * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ export function lessThanOrEqual( left: Expression, @@ -6351,14 +6522,15 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a given expression's value is less than or equal to a constant value. * + * @example * ```typescript * // Check if the 'quantity' field is less than or equal to 20 * lessThanOrEqual(field("quantity"), 20); * ``` * - * @param expression The {@link Expression} to compare. + * @param expression The `Expression` to compare. * @param value The constant value to compare against. - * @return A new {@link BooleanExpression} representing the less than or equal to comparison. + * @returns A new `BooleanExpression` representing the less than or equal to comparison. */ export function lessThanOrEqual( expression: Expression, @@ -6369,6 +6541,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is less than or equal to another expression. * + * @example * ```typescript * // Check if the 'quantity' field is less than or equal to the 'limit' field * lessThanOrEqual("quantity", field("limit")); @@ -6376,7 +6549,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field whose value will be compared. * @param expression The expression to compare against the field's value. - * @return A new {@link BooleanExpression} representing the less than or equal to comparison. + * @returns A new `BooleanExpression` representing the less than or equal to comparison. */ export function lessThanOrEqual( fieldName: string, @@ -6386,6 +6559,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is less than or equal to a constant value. * + * @example * ```typescript * // Check if the 'score' field is less than or equal to 70 * lessThanOrEqual("score", 70); @@ -6393,7 +6567,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the less than or equal to comparison. + * @returns A new `Expression` representing the less than or equal to comparison. */ export function lessThanOrEqual( fieldName: string, @@ -6404,6 +6578,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if the first expression is greater than the second * expression. * + * @example * ```typescript * // Check if the 'age' field is greater than 18 * greaterThan(field("age"), constant(9).add(9)); @@ -6411,7 +6586,7 @@ declare namespace FirebaseFirestore { * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ export function greaterThan( left: Expression, @@ -6421,6 +6596,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if an expression is greater than a constant value. * + * @example * ```typescript * // Check if the 'age' field is greater than 18 * greaterThan(field("age"), 18); @@ -6428,7 +6604,7 @@ declare namespace FirebaseFirestore { * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the greater than comparison. + * @returns A new `Expression` representing the greater than comparison. */ export function greaterThan( expression: Expression, @@ -6439,6 +6615,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is greater than another expression. * + * @example * ```typescript * // Check if the value of field 'age' is greater than the value of field 'limit' * greaterThan("age", field("limit")); @@ -6446,7 +6623,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field to compare. * @param expression The expression to compare against. - * @return A new {@link BooleanExpression} representing the greater than comparison. + * @returns A new `BooleanExpression` representing the greater than comparison. */ export function greaterThan( fieldName: string, @@ -6456,6 +6633,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is greater than a constant value. * + * @example * ```typescript * // Check if the 'price' field is greater than 100 * greaterThan("price", 100); @@ -6463,7 +6641,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field to compare. * @param value The constant value to compare to. - * @return A new {@link BooleanExpression} representing the greater than comparison. + * @returns A new `BooleanExpression` representing the greater than comparison. */ export function greaterThan( fieldName: string, @@ -6474,6 +6652,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if the first expression is greater than or equal to the * second expression. * + * @example * ```typescript * // Check if the 'quantity' field is greater than or equal to the field "threshold" * greaterThanOrEqual(field("quantity"), field("threshold")); @@ -6481,7 +6660,7 @@ declare namespace FirebaseFirestore { * * @param left The first expression to compare. * @param right The second expression to compare. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ export function greaterThanOrEqual( left: Expression, @@ -6492,6 +6671,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if an expression is greater than or equal to a constant * value. * + * @example * ```typescript * // Check if the 'quantity' field is greater than or equal to 10 * greaterThanOrEqual(field("quantity"), 10); @@ -6499,7 +6679,7 @@ declare namespace FirebaseFirestore { * * @param expression The expression to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ export function greaterThanOrEqual( expression: Expression, @@ -6509,6 +6689,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's value is greater than or equal to an expression. * + * @example * ```typescript * // Check if the value of field 'age' is greater than or equal to the value of field 'limit' * greaterThanOrEqual("age", field("limit")); @@ -6516,7 +6697,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param value The expression to compare to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ export function greaterThanOrEqual( fieldName: string, @@ -6527,6 +6708,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if a field's value is greater than or equal to a constant * value. * + * @example * ```typescript * // Check if the 'score' field is greater than or equal to 80 * greaterThanOrEqual("score", 80); @@ -6534,7 +6716,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param value The constant value to compare to. - * @return A new `Expression` representing the greater than or equal to comparison. + * @returns A new `Expression` representing the greater than or equal to comparison. */ export function greaterThanOrEqual( fieldName: string, @@ -6546,6 +6728,7 @@ declare namespace FirebaseFirestore { * * Creates an expression that concatenates an array expression with other arrays. * + * @example * ```typescript * // Combine the 'items' array with two new item arrays * arrayConcat(field("items"), [field("newItems"), field("otherItems")]); @@ -6554,7 +6737,7 @@ declare namespace FirebaseFirestore { * @param firstArray The first array expression to concatenate to. * @param secondArray The second array expression or array literal to concatenate to. * @param otherArrays Optional additional array expressions or array literals to concatenate. - * @return A new {@code Expr} representing the concatenated array. + * @returns A new {@code Expr} representing the concatenated array. */ export function arrayConcat( firstArray: Expression, @@ -6567,6 +6750,7 @@ declare namespace FirebaseFirestore { * * Creates an expression that concatenates a field's array value with other arrays. * + * @example * ```typescript * // Combine the 'items' array with two new item arrays * arrayConcat("items", [field("newItems"), field("otherItems")]); @@ -6575,7 +6759,7 @@ declare namespace FirebaseFirestore { * @param firstArrayField The first array to concatenate to. * @param secondArray The second array expression or array literal to concatenate to. * @param otherArrays Optional additional array expressions or array literals to concatenate. - * @return A new {@code Expr} representing the concatenated array. + * @returns A new {@code Expr} representing the concatenated array. */ export function arrayConcat( firstArrayField: string, @@ -6587,6 +6771,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if an array expression contains a specific element. * + * @example * ```typescript * // Check if the 'colors' array contains the value of field 'selectedColor' * arrayContains(field("colors"), field("selectedColor")); @@ -6594,7 +6779,7 @@ declare namespace FirebaseFirestore { * * @param array The array expression to check. * @param element The element to search for in the array. - * @return A new {@code Expression} representing the 'array_contains' comparison. + * @returns A new {@code Expression} representing the 'array_contains' comparison. */ export function arrayContains( array: Expression, @@ -6604,6 +6789,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if an array expression contains a specific element. * + * @example * ```typescript * // Check if the 'colors' array contains "red" * arrayContains(field("colors"), "red"); @@ -6611,7 +6797,7 @@ declare namespace FirebaseFirestore { * * @param array The array expression to check. * @param element The element to search for in the array. - * @return A new {@code Expression} representing the 'array_contains' comparison. + * @returns A new {@code Expression} representing the 'array_contains' comparison. */ export function arrayContains( array: Expression, @@ -6621,6 +6807,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's array value contains a specific element. * + * @example * ```typescript * // Check if the 'colors' array contains the value of field 'selectedColor' * arrayContains("colors", field("selectedColor")); @@ -6628,7 +6815,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param element The element to search for in the array. - * @return A new {@code Expression} representing the 'array_contains' comparison. + * @returns A new {@code Expression} representing the 'array_contains' comparison. */ export function arrayContains( fieldName: string, @@ -6638,6 +6825,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's array value contains a specific value. * + * @example * ```typescript * // Check if the 'colors' array contains "red" * arrayContains("colors", "red"); @@ -6645,7 +6833,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param element The element to search for in the array. - * @return A new {@code Expression} representing the 'array_contains' comparison. + * @returns A new {@code Expression} representing the 'array_contains' comparison. */ export function arrayContains( fieldName: string, @@ -6656,6 +6844,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if an array expression contains any of the specified * elements. * + * @example * ```typescript * // Check if the 'categories' array contains either values from field "cate1" or "Science" * arrayContainsAny(field("categories"), [field("cate1"), "Science"]); @@ -6663,7 +6852,7 @@ declare namespace FirebaseFirestore { * * @param array The array expression to check. * @param values The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_any' comparison. + * @returns A new {@code Expression} representing the 'array_contains_any' comparison. */ export function arrayContainsAny( array: Expression, @@ -6674,6 +6863,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if a field's array value contains any of the specified * elements. * + * @example * ```typescript * // Check if the 'groups' array contains either the value from the 'userGroup' field * // or the value "guest" @@ -6682,7 +6872,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param values The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_any' comparison. + * @returns A new {@code Expression} representing the 'array_contains_any' comparison. */ export function arrayContainsAny( fieldName: string, @@ -6693,6 +6883,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if an array expression contains any of the specified * elements. * + * @example * ```typescript * // Check if the 'categories' array contains either values from field "cate1" or "Science" * arrayContainsAny(field("categories"), array([field("cate1"), "Science"])); @@ -6700,7 +6891,7 @@ declare namespace FirebaseFirestore { * * @param array The array expression to check. * @param values An expression that evaluates to an array, whose elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_any' comparison. + * @returns A new {@code Expression} representing the 'array_contains_any' comparison. */ export function arrayContainsAny( array: Expression, @@ -6711,6 +6902,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if a field's array value contains any of the specified * elements. * + * @example * ```typescript * // Check if the 'groups' array contains either the value from the 'userGroup' field * // or the value "guest" @@ -6719,7 +6911,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param values An expression that evaluates to an array, whose elements to check for in the array field. - * @return A new {@code Expression} representing the 'array_contains_any' comparison. + * @returns A new {@code Expression} representing the 'array_contains_any' comparison. */ export function arrayContainsAny( fieldName: string, @@ -6729,6 +6921,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if an array expression contains all the specified elements. * + * @example * ```typescript * // Check if the "tags" array contains all of the values: "SciFi", "Adventure", and the value from field "tag1" * arrayContainsAll(field("tags"), [field("tag1"), constant("SciFi"), "Adventure"]); @@ -6736,7 +6929,7 @@ declare namespace FirebaseFirestore { * * @param array The array expression to check. * @param values The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_all' comparison. + * @returns A new {@code Expression} representing the 'array_contains_all' comparison. */ export function arrayContainsAll( array: Expression, @@ -6747,6 +6940,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if a field's array value contains all the specified values or * expressions. * + * @example * ```typescript * // Check if the 'tags' array contains both of the values from field 'tag1', the value "SciFi", and "Adventure" * arrayContainsAll("tags", [field("tag1"), "SciFi", "Adventure"]); @@ -6754,7 +6948,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param values The elements to check for in the array. - * @return A new {@code Expression} representing the 'array_contains_all' comparison. + * @returns A new {@code Expression} representing the 'array_contains_all' comparison. */ export function arrayContainsAll( fieldName: string, @@ -6768,6 +6962,7 @@ declare namespace FirebaseFirestore { * The `arrayExpression` parameter should be an expression that evaluates to an array of elements * to check for within the `array`. * + * @example * ```typescript * // Check if the "tags" array contains all elements from the "requiredTags" field. * arrayContainsAll(field("tags"), field("requiredTags")); @@ -6778,7 +6973,7 @@ declare namespace FirebaseFirestore { * * @param array An expression evaluating to the array to check. * @param arrayExpression An expression evaluating to an array of elements to check for. - * @return A new {@code BooleanExpression} representing the 'array_contains_all' comparison. + * @returns A new {@code BooleanExpression} representing the 'array_contains_all' comparison. */ export function arrayContainsAll( array: Expression, @@ -6789,6 +6984,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a field's array value contains all the elements specified by another expression. * + * @example * ```typescript * // Check if the 'tags' array contains all values present in the 'requiredTags' field. * arrayContainsAll("tags", field("requiredTags")); @@ -6796,7 +6992,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the array field to check. * @param arrayExpression An expression that evaluates to an array of values to check for. - * @return A new {@code BooleanExpression} representing the 'array_contains_all' comparison. + * @returns A new {@code BooleanExpression} representing the 'array_contains_all' comparison. */ export function arrayContainsAll( fieldName: string, @@ -6806,26 +7002,28 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that calculates the length of an array in a specified field. * + * @example * ```typescript * // Get the number of items in field 'cart' * arrayLength('cart'); * ``` * * @param fieldName The name of the field containing an array to calculate the length of. - * @return A new {@code Expression} representing the length of the array. + * @returns A new {@code Expression} representing the length of the array. */ export function arrayLength(fieldName: string): FunctionExpression; /** * @beta * Creates an expression that calculates the length of an array expression. * + * @example * ```typescript * // Get the number of items in the 'cart' array * arrayLength(field("cart")); * ``` * * @param array The array expression to calculate the length of. - * @return A new {@code Expression} representing the length of the array. + * @returns A new {@code Expression} representing the length of the array. */ export function arrayLength(array: Expression): FunctionExpression; /** @@ -6833,6 +7031,7 @@ declare namespace FirebaseFirestore { * Creates an expression that checks if an expression, when evaluated, is equal to any of the provided values or * expressions. * + * @example * ```typescript * // Check if the 'category' field is either "Electronics" or value of field 'primaryType' * equalAny(field("category"), [constant("Electronics"), field("primaryType")]); @@ -6840,7 +7039,7 @@ declare namespace FirebaseFirestore { * * @param expression The expression whose results to compare. * @param values The values to check against. - * @return A new {@code Expression} representing the 'IN' comparison. + * @returns A new {@code Expression} representing the 'IN' comparison. */ export function equalAny( expression: Expression, @@ -6857,7 +7056,7 @@ declare namespace FirebaseFirestore { * * @param expression The expression whose results to compare. * @param arrayExpression An expression that evaluates to an array, whose elements to check for equality to the input. - * @return A new {@code Expression} representing the 'IN' comparison. + * @returns A new {@code Expression} representing the 'IN' comparison. */ export function equalAny( expression: Expression, @@ -6875,7 +7074,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field to compare. * @param values The values to check against. - * @return A new {@code Expression} representing the 'IN' comparison. + * @returns A new {@code Expression} representing the 'IN' comparison. */ export function equalAny( fieldName: string, @@ -6896,7 +7095,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field to compare. * @param arrayExpression An expression that evaluates to an array. The function checks if the value of `fieldName` is equal to any element within this array. - * @return A new {@code BooleanExpression} representing the 'IN' comparison. + * @returns A new {@code BooleanExpression} representing the 'IN' comparison. */ export function equalAny( fieldName: string, @@ -6914,7 +7113,7 @@ declare namespace FirebaseFirestore { * * @param element The expression to compare. * @param values The values to check against. - * @return A new {@code Expression} representing the 'NOT IN' comparison. + * @returns A new {@code Expression} representing the 'NOT IN' comparison. */ export function notEqualAny( element: Expression, @@ -6932,7 +7131,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param values The values to check against. - * @return A new {@code Expression} representing the 'NOT IN' comparison. + * @returns A new {@code Expression} representing the 'NOT IN' comparison. */ export function notEqualAny( fieldName: string, @@ -6951,7 +7150,7 @@ declare namespace FirebaseFirestore { * * @param element The expression representing the value to check. * @param arrayExpression An expression that evaluates to an array of values to check against. - * @return A new {@code BooleanExpression} representing the 'NOT IN' comparison. + * @returns A new {@code BooleanExpression} representing the 'NOT IN' comparison. */ export function notEqualAny( element: Expression, @@ -6968,7 +7167,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to compare. * @param arrayExpression The values to check against. - * @return A new {@code Expression} representing the 'NOT IN' comparison. + * @returns A new {@code Expression} representing the 'NOT IN' comparison. */ export function notEqualAny( fieldName: string, @@ -6993,7 +7192,7 @@ declare namespace FirebaseFirestore { * @param first The first Boolean expression. * @param second The second Boolean expression. * @param additionalConditions Optional: Additional Boolean expressions to include in the XOR operation. - * @returns A new {@link BooleanExpression} representing the logical 'XOR' operation. + * @returns A new `BooleanExpression` representing the logical 'XOR' operation. */ export function xor( first: BooleanExpression, @@ -7014,7 +7213,7 @@ declare namespace FirebaseFirestore { * @param condition The condition to evaluate. * @param thenExpr The expression to evaluate if the condition is true. * @param elseExpr The expression to evaluate if the condition is false. - * @return A new {@code Expression} representing the conditional expression. + * @returns A new {@code Expression} representing the conditional expression. */ export function conditional( condition: BooleanExpression, @@ -7031,7 +7230,7 @@ declare namespace FirebaseFirestore { * ``` * * @param booleanExpr The filter condition to negate. - * @return A new {@code Expression} representing the negated filter condition. + * @returns A new {@code Expression} representing the negated filter condition. */ export function not(booleanExpr: BooleanExpression): BooleanExpression; /** @@ -7048,7 +7247,7 @@ declare namespace FirebaseFirestore { * @param first The first operand expression. * @param second The second expression or literal. * @param others Optional additional expressions or literals. - * @return A new {@code Expression} representing the logical max operation. + * @returns A new {@code Expression} representing the logical max operation. */ export function logicalMaximum( first: Expression, @@ -7069,7 +7268,7 @@ declare namespace FirebaseFirestore { * @param fieldName The first operand field name. * @param second The second expression or literal. * @param others Optional additional expressions or literals. - * @return A new {@code Expression} representing the logical max operation. + * @returns A new {@code Expression} representing the logical max operation. */ export function logicalMaximum( fieldName: string, @@ -7090,7 +7289,7 @@ declare namespace FirebaseFirestore { * @param first The first operand expression. * @param second The second expression or literal. * @param others Optional additional expressions or literals. - * @return A new {@code Expression} representing the logical min operation. + * @returns A new {@code Expression} representing the logical min operation. */ export function logicalMinimum( first: Expression, @@ -7112,7 +7311,7 @@ declare namespace FirebaseFirestore { * @param fieldName The first operand field name. * @param second The second expression or literal. * @param others Optional additional expressions or literals. - * @return A new {@code Expression} representing the logical min operation. + * @returns A new {@code Expression} representing the logical min operation. */ export function logicalMinimum( fieldName: string, @@ -7130,7 +7329,7 @@ declare namespace FirebaseFirestore { * ``` * * @param value An expression representing the field to check for existence. - * @return A new {@code BooleanExpression} representing the 'exists' check. + * @returns A new {@code BooleanExpression} representing the 'exists' check. */ export function exists(value: Expression): BooleanExpression; /** @@ -7143,7 +7342,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The field name to check. - * @return A new {@code Expression} representing the 'exists' check. + * @returns A new {@code Expression} representing the 'exists' check. */ export function exists(fieldName: string): BooleanExpression; @@ -7157,7 +7356,7 @@ declare namespace FirebaseFirestore { * ``` * * @param stringExpression An expression evaluating to a string value, which will be reversed. - * @return A new {@code Expression} representing the reversed string. + * @returns A new {@code Expression} representing the reversed string. */ export function reverse(stringExpression: Expression): FunctionExpression; /** @@ -7170,7 +7369,7 @@ declare namespace FirebaseFirestore { * ``` * * @param field The name of the field representing the string to reverse. - * @return A new {@code Expression} representing the reversed string. + * @returns A new {@code Expression} representing the reversed string. */ export function reverse(field: string): FunctionExpression; /** @@ -7183,7 +7382,7 @@ declare namespace FirebaseFirestore { * ``` * * @param arrayExpression An expression evaluating to an array value, which will be reversed. - * @return A new {@code Expression} representing the reversed array. + * @returns A new {@code Expression} representing the reversed array. */ export function arrayReverse( arrayExpression: Expression, @@ -7198,7 +7397,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to reverse. - * @return A new {@code Expression} representing the reversed array. + * @returns A new {@code Expression} representing the reversed array. */ export function arrayReverse(fieldName: string): FunctionExpression; /** @@ -7211,7 +7410,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression An expression evaluating to a numeric value, which the ceiling will be computed for. - * @return A new {@code Expression} representing the ceiling of the numeric value. + * @returns A new {@code Expression} representing the ceiling of the numeric value. */ export function ceil(expression: Expression): FunctionExpression; /** @@ -7224,7 +7423,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to compute the ceiling of. - * @return A new {@code Expression} representing the ceiling of the numeric value. + * @returns A new {@code Expression} representing the ceiling of the numeric value. */ export function ceil(fieldName: string): FunctionExpression; @@ -7254,7 +7453,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field whose numeric value will be used as the exponent. - * @return A new {@code FunctionExpression} representing 'e' raised to the power of the numeric value. + * @returns A new {@code FunctionExpression} representing 'e' raised to the power of the numeric value. */ export function exp(fieldName: string): FunctionExpression; /** @@ -7262,7 +7461,7 @@ declare namespace FirebaseFirestore { * Creates an aggregation that counts the number of distinct values of an evaluated expression. * * @param expression The expression to count distinct values of. - * @return A new `AggregateFunction` representing the 'count_distinct' aggregation. + * @returns A new `AggregateFunction` representing the 'count_distinct' aggregation. */ export function countDistinct(expression: Expression): AggregateFunction; /** @@ -7270,7 +7469,7 @@ declare namespace FirebaseFirestore { * Creates an aggregation that counts the number of distinct values of a field. * * @param fieldName The field to count distinct values of. - * @return A new `AggregateFunction` representing the 'count_distinct' aggregation. + * @returns A new `AggregateFunction` representing the 'count_distinct' aggregation. */ export function countDistinct(fieldName: string): AggregateFunction; /** @@ -7283,7 +7482,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression representing the string. - * @return A new {@code Expression} representing the length of the string in bytes. + * @returns A new {@code Expression} representing the length of the string in bytes. */ export function byteLength(expr: Expression): FunctionExpression; /** @@ -7296,7 +7495,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field containing the string. - * @return A new {@code Expression} representing the length of the string in bytes. + * @returns A new {@code Expression} representing the length of the string in bytes. */ export function byteLength(fieldName: string): FunctionExpression; @@ -7310,7 +7509,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field containing the string. - * @return A new {@code Expression} representing the length of the string. + * @returns A new {@code Expression} representing the length of the string. */ export function charLength(fieldName: string): FunctionExpression; @@ -7324,7 +7523,7 @@ declare namespace FirebaseFirestore { * ``` * * @param stringExpression The expression representing the string to calculate the length of. - * @return A new {@code Expression} representing the length of the string. + * @returns A new {@code Expression} representing the length of the string. */ export function charLength( stringExpression: Expression, @@ -7341,7 +7540,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the string. * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new {@code Expression} representing the 'like' comparison. + * @returns A new {@code Expression} representing the 'like' comparison. */ export function like(fieldName: string, pattern: string): BooleanExpression; /** @@ -7356,7 +7555,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the string. * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new {@code Expression} representing the 'like' comparison. + * @returns A new {@code Expression} representing the 'like' comparison. */ export function like( fieldName: string, @@ -7374,7 +7573,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression representing the string to perform the comparison on. * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new {@code BooleanExpression} representing the 'like' comparison. + * @returns A new {@code BooleanExpression} representing the 'like' comparison. */ export function like( stringExpression: Expression, @@ -7391,7 +7590,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression representing the string to perform the comparison on. * @param pattern The pattern to search for. You can use "%" as a wildcard character. - * @return A new {@code Expression} representing the 'like' comparison. + * @returns A new {@code Expression} representing the 'like' comparison. */ export function like( stringExpression: Expression, @@ -7409,7 +7608,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the string. * @param pattern The regular expression to use for the search. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new {@code Expression} representing the 'contains' comparison. */ export function regexContains( fieldName: string, @@ -7427,7 +7626,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the string. * @param pattern The regular expression to use for the search. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new {@code Expression} representing the 'contains' comparison. */ export function regexContains( fieldName: string, @@ -7446,7 +7645,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression representing the string to perform the regex comparison on. * @param pattern The regular expression string to search for within the `stringExpression`. - * @return A new {@code BooleanExpression} representing the result of the regex contains comparison. + * @returns A new {@code BooleanExpression} representing the result of the regex contains comparison. */ export function regexContains( stringExpression: Expression, @@ -7468,7 +7667,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression representing the string to perform the comparison on. * @param pattern The regular expression to use for the search. - * @return A new {@code BooleanExpression} representing the 'contains' comparison. + * @returns A new {@code BooleanExpression} representing the 'contains' comparison. */ export function regexContains( stringExpression: Expression, @@ -7485,7 +7684,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the string. * @param pattern The regular expression to use for the match. - * @return A new {@code Expression} representing the regular expression match. + * @returns A new {@code Expression} representing the regular expression match. */ export function regexMatch( fieldName: string, @@ -7496,7 +7695,7 @@ declare namespace FirebaseFirestore { * @beta * Creates an expression that checks if a string field matches a specified regular expression. * - * The `pattern` parameter is an {@link Expression} that evaluates to the regular expression string. + * The `pattern` parameter is an `Expression` that evaluates to the regular expression string. * This allows for dynamic regex patterns, such as those stored in other fields. * * ```typescript @@ -7505,8 +7704,8 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field containing the string value to be matched. - * @param pattern An {@link Expression} that evaluates to the regular expression string to use for the match. - * @return A new {@link BooleanExpression} representing the result of the regular expression match. + * @param pattern An `Expression` that evaluates to the regular expression string to use for the match. + * @returns A new `BooleanExpression` representing the result of the regular expression match. */ export function regexMatch( fieldName: string, @@ -7525,7 +7724,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression An expression that evaluates to the string to match against. * @param pattern The regular expression to use for the match. - * @return A new {@link BooleanExpression} representing the result of the regular expression match. + * @returns A new `BooleanExpression` representing the result of the regular expression match. */ export function regexMatch( stringExpression: Expression, @@ -7543,7 +7742,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression representing the string to match against. * @param pattern The regular expression to use for the match. - * @return A new {@code Expression} representing the regular expression match. + * @returns A new {@code Expression} representing the regular expression match. */ export function regexMatch( stringExpression: Expression, @@ -7560,7 +7759,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the string. * @param substring The substring to search for. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new {@code Expression} representing the 'contains' comparison. */ export function stringContains( fieldName: string, @@ -7577,7 +7776,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the string. * @param substring The expression representing the substring to search for. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new {@code Expression} representing the 'contains' comparison. */ export function stringContains( fieldName: string, @@ -7594,7 +7793,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression representing the string to perform the comparison on. * @param substring The substring to search for. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new {@code Expression} representing the 'contains' comparison. */ export function stringContains( stringExpression: Expression, @@ -7611,7 +7810,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression representing the string to perform the comparison on. * @param substring The expression representing the substring to search for. - * @return A new {@code Expression} representing the 'contains' comparison. + * @returns A new {@code Expression} representing the 'contains' comparison. */ export function stringContains( stringExpression: Expression, @@ -7628,7 +7827,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param prefix The prefix to check for. - * @return A new {@code Expression} representing the 'starts with' comparison. + * @returns A new {@code Expression} representing the 'starts with' comparison. */ export function startsWith( fieldName: string, @@ -7645,7 +7844,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param prefix The expression representing the prefix. - * @return A new {@code Expression} representing the 'starts with' comparison. + * @returns A new {@code Expression} representing the 'starts with' comparison. */ export function startsWith( fieldName: string, @@ -7663,7 +7862,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression An expression that evaluates to a string, which will be checked for the prefix. * @param prefix The string prefix to check for. - * @return A new {@code BooleanExpression} representing the 'starts with' comparison. + * @returns A new {@code BooleanExpression} representing the 'starts with' comparison. */ export function startsWith( stringExpression: Expression, @@ -7681,7 +7880,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The string expression to check. * @param prefix The prefix expression to check for. - * @return A new {@code BooleanExpression} representing the 'starts with' comparison. + * @returns A new {@code BooleanExpression} representing the 'starts with' comparison. */ export function startsWith( stringExpression: Expression, @@ -7699,7 +7898,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param suffix The suffix to check for. - * @return A new {@link BooleanExpression} representing the 'ends with' comparison. + * @returns A new `BooleanExpression` representing the 'ends with' comparison. */ export function endsWith( fieldName: string, @@ -7716,7 +7915,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name to check. * @param suffix The expression representing the postfix. - * @return A new {@code Expression} representing the 'ends with' comparison. + * @returns A new {@code Expression} representing the 'ends with' comparison. */ export function endsWith( fieldName: string, @@ -7733,7 +7932,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression to check. * @param suffix The postfix to check for. - * @return A new {@code Expression} representing the 'ends with' comparison. + * @returns A new {@code Expression} representing the 'ends with' comparison. */ export function endsWith( stringExpression: Expression, @@ -7750,7 +7949,7 @@ declare namespace FirebaseFirestore { * * @param stringExpression The expression to check. * @param suffix The postfix to check for. - * @return A new {@code Expression} representing the 'ends with' comparison. + * @returns A new {@code Expression} representing the 'ends with' comparison. */ export function endsWith( stringExpression: Expression, @@ -7767,7 +7966,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field containing the string. - * @return A new {@code Expression} representing the lowercase string. + * @returns A new {@code Expression} representing the lowercase string. */ export function toLower(fieldName: string): FunctionExpression; @@ -7781,7 +7980,7 @@ declare namespace FirebaseFirestore { * ``` * * @param stringExpression The expression representing the string to convert to lowercase. - * @return A new {@code Expression} representing the lowercase string. + * @returns A new {@code Expression} representing the lowercase string. */ export function toLower(stringExpression: Expression): FunctionExpression; /** @@ -7794,7 +7993,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field containing the string. - * @return A new {@code Expression} representing the uppercase string. + * @returns A new {@code Expression} representing the uppercase string. */ export function toUpper(fieldName: string): FunctionExpression; @@ -7808,7 +8007,7 @@ declare namespace FirebaseFirestore { * ``` * * @param stringExpression The expression representing the string to convert to uppercase. - * @return A new {@code FunctionExpression} representing the uppercase string. + * @returns A new {@code FunctionExpression} representing the uppercase string. */ export function toUpper(stringExpression: Expression): FunctionExpression; /** @@ -7827,7 +8026,7 @@ declare namespace FirebaseFirestore { * @param fieldName The name of the field containing the string or byte array. * @param valueToTrim Optional This parameter is treated as a set of characters or bytes that will be * trimmed from the input. If not specified, then whitespace will be trimmed. - * @return A new {@code Expr} representing the trimmed string. + * @returns A new {@code Expr} representing the trimmed string. */ export function trim( fieldName: string, @@ -7850,7 +8049,7 @@ declare namespace FirebaseFirestore { * @param stringExpression The expression representing the string or byte array to trim. * @param valueToTrim Optional This parameter is treated as a set of characters or bytes that will be * trimmed from the input. If not specified, then whitespace will be trimmed. - * @return A new {@code Expr} representing the trimmed string or byte array. + * @returns A new {@code Expr} representing the trimmed string or byte array. */ export function trim( stringExpression: Expression, @@ -7869,7 +8068,7 @@ declare namespace FirebaseFirestore { * @param fieldName The name of the field to use as the initial string value for concatenation. * @param secondString An expression or string literal to concatenate. * @param otherStrings Optional additional expressions or literals (typically strings) to concatenate. - * @return A new {@code FunctionExpression} representing the concatenated string. + * @returns A new {@code FunctionExpression} representing the concatenated string. */ export function stringConcat( fieldName: string, @@ -7888,7 +8087,7 @@ declare namespace FirebaseFirestore { * @param firstString The initial string expression to concatenate to. * @param secondString An expression or string literal to concatenate. * @param otherStrings Optional additional expressions or literals (typically strings) to concatenate. - * @return A new {@code Expression} representing the concatenated string. + * @returns A new {@code Expression} representing the concatenated string. */ export function stringConcat( firstString: Expression, @@ -7906,7 +8105,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The field name of the map field. * @param subField The key to access in the map. - * @return A new {@code Expression} representing the value associated with the given key in the map. + * @returns A new {@code Expression} representing the value associated with the given key in the map. */ export function mapGet( fieldName: string, @@ -7923,7 +8122,7 @@ declare namespace FirebaseFirestore { * * @param mapExpression The expression representing the map. * @param subField The key to access in the map. - * @return A new {@code Expression} representing the value associated with the given key in the map. + * @returns A new {@code Expression} representing the value associated with the given key in the map. */ export function mapGet( mapExpression: Expression, @@ -7938,7 +8137,7 @@ declare namespace FirebaseFirestore { * countAll().as("totalDocument"); * ``` * - * @return A new {@code AggregateFunction} representing the 'countAll' aggregation. + * @returns A new {@code AggregateFunction} representing the 'countAll' aggregation. */ export function countAll(): AggregateFunction; /** @@ -7952,7 +8151,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression The expression to count. - * @return A new {@code AggregateFunction} representing the 'count' aggregation. + * @returns A new {@code AggregateFunction} representing the 'count' aggregation. */ export function count(expression: Expression): AggregateFunction; /** @@ -7965,7 +8164,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to count. - * @return A new {@code AggregateFunction} representing the 'count' aggregation. + * @returns A new {@code AggregateFunction} representing the 'count' aggregation. */ export function count(fieldName: string): AggregateFunction; /** @@ -7979,7 +8178,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression The expression to sum up. - * @return A new {@code AggregateFunction} representing the 'sum' aggregation. + * @returns A new {@code AggregateFunction} representing the 'sum' aggregation. */ export function sum(expression: Expression): AggregateFunction; /** @@ -7993,7 +8192,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field containing numeric values to sum up. - * @return A new {@code AggregateFunction} representing the 'sum' aggregation. + * @returns A new {@code AggregateFunction} representing the 'sum' aggregation. */ export function sum(fieldName: string): AggregateFunction; /** @@ -8007,7 +8206,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression The expression representing the values to average. - * @return A new {@code AggregateFunction} representing the 'average' aggregation. + * @returns A new {@code AggregateFunction} representing the 'average' aggregation. */ export function average(expression: Expression): AggregateFunction; /** @@ -8021,7 +8220,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field containing numeric values to average. - * @return A new {@code AggregateFunction} representing the 'average' aggregation. + * @returns A new {@code AggregateFunction} representing the 'average' aggregation. */ export function average(fieldName: string): AggregateFunction; /** @@ -8035,7 +8234,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression The expression to find the minimum value of. - * @return A new {@code AggregateFunction} representing the 'min' aggregation. + * @returns A new {@code AggregateFunction} representing the 'min' aggregation. */ export function minimum(expression: Expression): AggregateFunction; /** @@ -8048,7 +8247,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to find the minimum value of. - * @return A new {@code AggregateFunction} representing the 'min' aggregation. + * @returns A new {@code AggregateFunction} representing the 'min' aggregation. */ export function minimum(fieldName: string): AggregateFunction; /** @@ -8062,7 +8261,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression The expression to find the maximum value of. - * @return A new {@code AggregateFunction} representing the 'max' aggregation. + * @returns A new {@code AggregateFunction} representing the 'max' aggregation. */ export function maximum(expression: Expression): AggregateFunction; /** @@ -8075,7 +8274,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to find the maximum value of. - * @return A new {@code AggregateFunction} representing the 'max' aggregation. + * @returns A new {@code AggregateFunction} representing the 'max' aggregation. */ export function maximum(fieldName: string): AggregateFunction; /** @@ -8089,7 +8288,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the first vector. * @param vector The other vector (as an array of doubles) or {@link VectorValue} to compare against. - * @return A new {@code Expression} representing the Cosine distance between the two vectors. + * @returns A new {@code Expression} representing the Cosine distance between the two vectors. */ export function cosineDistance( fieldName: string, @@ -8106,7 +8305,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the first vector. * @param vectorExpression The other vector (represented as an Expression) to compare against. - * @return A new {@code Expression} representing the cosine distance between the two vectors. + * @returns A new {@code Expression} representing the cosine distance between the two vectors. */ export function cosineDistance( fieldName: string, @@ -8129,9 +8328,9 @@ declare namespace FirebaseFirestore { * cosineDistance(field("vector1"), field("vector2")); * ``` * - * @param vectorExpression The first vector, represented as an {@link Expression} (e.g., a field path). - * @param vector The second vector, which can be either a numeric array literal (`number[]`) or another {@link Expression}. - * @return A new {@link FunctionExpression} representing the cosine distance. + * @param vectorExpression The first vector, represented as an `Expression` (e.g., a field path). + * @param vector The second vector, which can be either a numeric array literal (`number[]`) or another `Expression`. + * @returns A new {@link FunctionExpression} representing the cosine distance. */ export function cosineDistance( vectorExpression: Expression, @@ -8148,7 +8347,7 @@ declare namespace FirebaseFirestore { * * @param vectorExpression The first vector (represented as an Expression) to compare against. * @param otherVectorExpression The other vector (represented as an Expression) to compare against. - * @return A new {@code Expression} representing the cosine distance between the two vectors. + * @returns A new {@code Expression} representing the cosine distance between the two vectors. */ export function cosineDistance( vectorExpression: Expression, @@ -8165,7 +8364,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the first vector. * @param vector The other vector (as an array of doubles or VectorValue) to calculate with. - * @return A new {@code Expression} representing the dot product between the two vectors. + * @returns A new {@code Expression} representing the dot product between the two vectors. */ export function dotProduct( fieldName: string, @@ -8183,7 +8382,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the first vector. * @param vectorExpression The other vector (represented as an Expression) to calculate with. - * @return A new {@code Expression} representing the dot product between the two vectors. + * @returns A new {@code Expression} representing the dot product between the two vectors. */ export function dotProduct( fieldName: string, @@ -8201,7 +8400,7 @@ declare namespace FirebaseFirestore { * * @param vectorExpression The first vector (represented as an Expression) to calculate with. * @param vector The other vector (as an array of numbers or VectorValue) to calculate with. - * @return A new {@code Expression} representing the dot product between the two vectors. + * @returns A new {@code Expression} representing the dot product between the two vectors. */ export function dotProduct( vectorExpression: Expression, @@ -8218,7 +8417,7 @@ declare namespace FirebaseFirestore { * * @param vectorExpression The first vector (represented as an Expression) to calculate with. * @param otherVectorExpression The other vector (represented as an Expression) to calculate with. - * @return A new {@code Expression} representing the dot product between the two vectors. + * @returns A new {@code Expression} representing the dot product between the two vectors. */ export function dotProduct( vectorExpression: Expression, @@ -8237,7 +8436,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the first vector. * @param vector The other vector (as an array of doubles or VectorValue) to compare against. - * @return A new {@code Expression} representing the Euclidean distance between the two vectors. + * @returns A new {@code Expression} representing the Euclidean distance between the two vectors. */ export function euclideanDistance( fieldName: string, @@ -8254,7 +8453,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field containing the first vector. * @param vectorExpression The other vector (represented as an Expression) to compare against. - * @return A new {@code Expression} representing the Euclidean distance between the two vectors. + * @returns A new {@code Expression} representing the Euclidean distance between the two vectors. */ export function euclideanDistance( fieldName: string, @@ -8272,7 +8471,7 @@ declare namespace FirebaseFirestore { * * @param vectorExpression The first vector (represented as an Expression) to compare against. * @param vector The other vector (as an array of doubles or VectorValue) to compare against. - * @return A new {@code Expression} representing the Euclidean distance between the two vectors. + * @returns A new {@code Expression} representing the Euclidean distance between the two vectors. */ export function euclideanDistance( vectorExpression: Expression, @@ -8289,7 +8488,7 @@ declare namespace FirebaseFirestore { * * @param vectorExpression The first vector (represented as an Expression) to compare against. * @param otherVectorExpression The other vector (represented as an Expression) to compare against. - * @return A new {@code Expression} representing the Euclidean distance between the two vectors. + * @returns A new {@code Expression} representing the Euclidean distance between the two vectors. */ export function euclideanDistance( vectorExpression: Expression, @@ -8305,7 +8504,7 @@ declare namespace FirebaseFirestore { * ``` * * @param vectorExpression The expression representing the Firestore Vector. - * @return A new {@code Expression} representing the length of the array. + * @returns A new {@code Expression} representing the length of the array. */ export function vectorLength( vectorExpression: Expression, @@ -8321,7 +8520,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field representing the Firestore Vector. - * @return A new {@code FunctionExpression} representing the length (dimension) of the vector. + * @returns A new {@code FunctionExpression} representing the length (dimension) of the vector. */ export function vectorLength(fieldName: string): FunctionExpression; /** @@ -8335,7 +8534,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression representing the number of microseconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ export function unixMicrosToTimestamp(expr: Expression): FunctionExpression; /** @@ -8349,7 +8548,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field representing the number of microseconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ export function unixMicrosToTimestamp( fieldName: string, @@ -8364,7 +8563,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression representing the timestamp. - * @return A new {@code Expression} representing the number of microseconds since epoch. + * @returns A new {@code Expression} representing the number of microseconds since epoch. */ export function timestampToUnixMicros(expr: Expression): FunctionExpression; /** @@ -8377,7 +8576,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field representing the timestamp. - * @return A new {@code Expression} representing the number of microseconds since epoch. + * @returns A new {@code Expression} representing the number of microseconds since epoch. */ export function timestampToUnixMicros( fieldName: string, @@ -8393,7 +8592,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression representing the number of milliseconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ export function unixMillisToTimestamp(expr: Expression): FunctionExpression; /** @@ -8407,7 +8606,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field representing the number of milliseconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ export function unixMillisToTimestamp( fieldName: string, @@ -8422,7 +8621,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression representing the timestamp. - * @return A new {@code Expression} representing the number of milliseconds since epoch. + * @returns A new {@code Expression} representing the number of milliseconds since epoch. */ export function timestampToUnixMillis(expr: Expression): FunctionExpression; /** @@ -8435,7 +8634,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field representing the timestamp. - * @return A new {@code Expression} representing the number of milliseconds since epoch. + * @returns A new {@code Expression} representing the number of milliseconds since epoch. */ export function timestampToUnixMillis( fieldName: string, @@ -8451,7 +8650,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression representing the number of seconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ export function unixSecondsToTimestamp( expr: Expression, @@ -8467,7 +8666,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field representing the number of seconds since epoch. - * @return A new {@code Expression} representing the timestamp. + * @returns A new {@code Expression} representing the timestamp. */ export function unixSecondsToTimestamp( fieldName: string, @@ -8482,7 +8681,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression representing the timestamp. - * @return A new {@code Expression} representing the number of seconds since epoch. + * @returns A new {@code Expression} representing the number of seconds since epoch. */ export function timestampToUnixSeconds( expr: Expression, @@ -8497,7 +8696,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field representing the timestamp. - * @return A new {@code Expression} representing the number of seconds since epoch. + * @returns A new {@code Expression} representing the number of seconds since epoch. */ export function timestampToUnixSeconds( fieldName: string, @@ -8514,7 +8713,7 @@ declare namespace FirebaseFirestore { * @param timestamp The expression representing the timestamp. * @param unit The expression evaluates to unit of time, must be one of 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'day'. * @param amount The expression evaluates to amount of the unit. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ export function timestampAdd( timestamp: Expression, @@ -8534,7 +8733,7 @@ declare namespace FirebaseFirestore { * @param timestamp The expression representing the timestamp. * @param unit The unit of time to add: 'microsecond', 'millisecond', 'second', 'minute', 'hour', or 'day'. * @param amount The amount of time to add. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ export function timestampAdd( timestamp: Expression, @@ -8559,7 +8758,7 @@ declare namespace FirebaseFirestore { * @param fieldName The name of the field representing the timestamp. * @param unit The unit of time to add (e.g., "day", "hour"). * @param amount The amount of time to add. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ export function timestampAdd( fieldName: string, @@ -8584,7 +8783,7 @@ declare namespace FirebaseFirestore { * @param timestamp The expression representing the timestamp. * @param unit The expression evaluates to unit of time, must be one of 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'day'. * @param amount The expression evaluates to amount of the unit. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ export function timestampSubtract( timestamp: Expression, @@ -8603,7 +8802,7 @@ declare namespace FirebaseFirestore { * @param timestamp The expression representing the timestamp. * @param unit The unit of time to subtract (e.g., "day", "hour"). * @param amount The amount of time to subtract. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ export function timestampSubtract( timestamp: Expression, @@ -8628,7 +8827,7 @@ declare namespace FirebaseFirestore { * @param fieldName The name of the field representing the timestamp. * @param unit The unit of time to subtract (e.g., "day", "hour"). * @param amount The amount of time to subtract. - * @return A new {@code Expression} representing the resulting timestamp. + * @returns A new {@code Expression} representing the resulting timestamp. */ export function timestampSubtract( fieldName: string, @@ -8652,7 +8851,7 @@ declare namespace FirebaseFirestore { * currentTimestamp() * ``` * - * @return A new Expression representing the current server timestamp. + * @returns A new Expression representing the current server timestamp. */ export function currentTimestamp(): FunctionExpression; @@ -8669,7 +8868,7 @@ declare namespace FirebaseFirestore { * @param first The first filter condition. * @param second The second filter condition. * @param more Additional filter conditions to 'AND' together. - * @return A new {@code Expression} representing the logical 'AND' operation. + * @returns A new {@code Expression} representing the logical 'AND' operation. */ export function and( first: BooleanExpression, @@ -8689,7 +8888,7 @@ declare namespace FirebaseFirestore { * @param first The first filter condition. * @param second The second filter condition. * @param more Additional filter conditions to 'OR' together. - * @return A new {@code Expression} representing the logical 'OR' operation. + * @returns A new {@code Expression} representing the logical 'OR' operation. */ export function or( first: BooleanExpression, @@ -8707,7 +8906,7 @@ declare namespace FirebaseFirestore { * * @param base The expression to raise to the power of the exponent. * @param exponent The expression to raise the base to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ export function pow( base: Expression, @@ -8724,7 +8923,7 @@ declare namespace FirebaseFirestore { * * @param base The expression to raise to the power of the exponent. * @param exponent The constant value to raise the base to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ export function pow(base: Expression, exponent: number): FunctionExpression; /** @@ -8738,7 +8937,7 @@ declare namespace FirebaseFirestore { * * @param base The name of the field to raise to the power of the exponent. * @param exponent The expression to raise the base to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ export function pow(base: string, exponent: Expression): FunctionExpression; /** @@ -8752,7 +8951,7 @@ declare namespace FirebaseFirestore { * * @param base The name of the field to raise to the power of the exponent. * @param exponent The constant value to raise the base to the power of. - * @return A new `Expression` representing the power operation. + * @returns A new `Expression` representing the power operation. */ export function pow(base: string, exponent: number): FunctionExpression; /** @@ -8765,7 +8964,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression An expression evaluating to a path, which the collection ID will be extracted from. - * @return A new {@code Expression} representing the collectionId operation. + * @returns A new {@code Expression} representing the collectionId operation. */ export function collectionId(expression: Expression): FunctionExpression; /** @@ -8778,7 +8977,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to get the collection ID from. - * @return A new {@code Expression} representing the collectionId operation. + * @returns A new {@code Expression} representing the collectionId operation. */ export function collectionId(fieldName: string): FunctionExpression; /** @@ -8794,7 +8993,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression An expression evaluating to a string, array, map, vector, or bytes, which the length will be calculated for. - * @return A new `Expression` representing the length of the string, array, map, vector, or bytes. + * @returns A new `Expression` representing the length of the string, array, map, vector, or bytes. */ export function length(expression: Expression): FunctionExpression; /** @@ -8810,7 +9009,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to calculate the length of. - * @return A new `Expression` representing the length of the string, array, map, vector, or bytes. + * @returns A new `Expression` representing the length of the string, array, map, vector, or bytes. */ export function length(fieldName: string): FunctionExpression; /** @@ -8823,7 +9022,7 @@ declare namespace FirebaseFirestore { * ``` * * @param stringExpression An expression evaluating to a string value, which will be reversed. - * @return A new {@code Expression} representing the reversed string. + * @returns A new {@code Expression} representing the reversed string. */ export function stringReverse( stringExpression: Expression, @@ -8838,7 +9037,7 @@ declare namespace FirebaseFirestore { * ``` * * @param field The name of the field representing the string to reverse. - * @return A new {@code Expression} representing the reversed string. + * @returns A new {@code Expression} representing the reversed string. */ export function stringReverse(field: string): FunctionExpression; @@ -8854,7 +9053,7 @@ declare namespace FirebaseFirestore { * @param first The first expressions to concatenate. * @param second The second literal or expression to concatenate. * @param others Additional literals or expressions to concatenate. - * @return A new `Expression` representing the concatenation. + * @returns A new `Expression` representing the concatenation. */ export function concat( first: Expression, @@ -8867,7 +9066,7 @@ declare namespace FirebaseFirestore { * Creates an expression that computes the absolute value of a numeric value. * * @param expr The expression to compute the absolute value of. - * @return A new {@code Expr} representing the absolute value of the numeric value. + * @returns A new {@code Expr} representing the absolute value of the numeric value. */ export function abs(expr: Expression): FunctionExpression; @@ -8884,7 +9083,7 @@ declare namespace FirebaseFirestore { * * @param ifExpr The expression to check for absence. * @param elseExpr The expression that will be evaluated and returned if [ifExpr] is absent. - * @return A new Expression representing the ifAbsent operation. + * @returns A new Expression representing the ifAbsent operation. */ export function ifAbsent( ifExpr: Expression, @@ -8904,7 +9103,7 @@ declare namespace FirebaseFirestore { * * @param ifExpr The expression to check for absence. * @param elseValue The value that will be returned if `ifExpr` evaluates to an absent value. - * @return A new [Expression] representing the ifAbsent operation. + * @returns A new [Expression] representing the ifAbsent operation. */ export function ifAbsent( ifExpr: Expression, @@ -8925,7 +9124,7 @@ declare namespace FirebaseFirestore { * @param ifFieldName The field to check for absence. * @param elseExpr The expression that will be evaluated and returned if `ifFieldName` is * absent. - * @return A new Expression representing the ifAbsent operation. + * @returns A new Expression representing the ifAbsent operation. */ export function ifAbsent( ifFieldName: string, @@ -8943,7 +9142,7 @@ declare namespace FirebaseFirestore { * * @param arrayFieldName The name of the field containing the array. * @param delimiter The string to use as a delimiter. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ export function join(arrayFieldName: string, delimiter: string): Expression; @@ -8958,7 +9157,7 @@ declare namespace FirebaseFirestore { * * @param arrayExpression An expression that evaluates to an array. * @param delimiterExpression The expression that evaluates to the delimiter string. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ export function join( arrayExpression: Expression, @@ -8976,7 +9175,7 @@ declare namespace FirebaseFirestore { * * @param arrayExpression An expression that evaluates to an array. * @param delimiter The string to use as a delimiter. - * @return A new Expression representing the join operation. + * @returns A new Expression representing the join operation. */ export function join( arrayExpression: Expression, @@ -8993,7 +9192,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to compute the base-10 logarithm of. - * @return A new `Expr` representing the base-10 logarithm of the numeric value. + * @returns A new `Expr` representing the base-10 logarithm of the numeric value. */ export function log10(fieldName: string): FunctionExpression; @@ -9007,7 +9206,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression An expression evaluating to a numeric value, which the base-10 logarithm will be computed for. - * @return A new `Expr` representing the base-10 logarithm of the numeric value. + * @returns A new `Expr` representing the base-10 logarithm of the numeric value. */ export function log10(expression: Expression): FunctionExpression; @@ -9021,7 +9220,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to compute the sum of. - * @return A new `Expr` representing the sum of the elements in the array. + * @returns A new `Expr` representing the sum of the elements in the array. */ export function arraySum(fieldName: string): FunctionExpression; @@ -9035,7 +9234,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression An expression evaluating to a numeric array, which the sum will be computed for. - * @return A new `Expr` representing the sum of the elements in the array. + * @returns A new `Expr` representing the sum of the elements in the array. */ export function arraySum(expression: Expression): FunctionExpression; /** @@ -9048,7 +9247,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression An expression evaluating to a numeric value, which the natural logarithm will be computed for. - * @return A new {@code Expression} representing the natural logarithm of the numeric value. + * @returns A new {@code Expression} representing the natural logarithm of the numeric value. */ export function ln(expression: Expression): FunctionExpression; /** @@ -9061,7 +9260,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to compute the natural logarithm of. - * @return A new {@code Expression} representing the natural logarithm of the numeric value. + * @returns A new {@code Expression} representing the natural logarithm of the numeric value. */ export function ln(fieldName: string): FunctionExpression; /** @@ -9074,7 +9273,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression An expression evaluating to a numeric value, which will be rounded. - * @return A new `Expression` representing the rounded value. + * @returns A new `Expression` representing the rounded value. */ export function round(expression: Expression): FunctionExpression; /** @@ -9087,7 +9286,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to round. - * @return A new `Expression` representing the rounded value. + * @returns A new `Expression` representing the rounded value. */ export function round(fieldName: string): FunctionExpression; /** @@ -9101,7 +9300,7 @@ declare namespace FirebaseFirestore { * * @param fieldName The name of the field to round. * @param decimalPlaces A constant or expression specifying the rounding precision in decimal places. - * @return A new `Expr` representing the rounded value. + * @returns A new `Expr` representing the rounded value. */ export function round( fieldName: string, @@ -9119,7 +9318,7 @@ declare namespace FirebaseFirestore { * * @param expression An expression evaluating to a numeric value, which will be rounded. * @param decimalPlaces A constant or expression specifying the rounding precision in decimal places. - * @return A new `Expr` representing the rounded value. + * @returns A new `Expr` representing the rounded value. */ export function round( expression: Expression, @@ -9135,7 +9334,7 @@ declare namespace FirebaseFirestore { * ``` * * @param expression An expression evaluating to a numeric value, which the square root will be computed for. - * @return A new {@code Expression} representing the square root of the numeric value. + * @returns A new {@code Expression} representing the square root of the numeric value. */ export function sqrt(expression: Expression): FunctionExpression; /** @@ -9148,7 +9347,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field to compute the square root of. - * @return A new {@code Expression} representing the square root of the numeric value. + * @returns A new {@code Expression} representing the square root of the numeric value. */ export function sqrt(fieldName: string): FunctionExpression; /** @@ -9164,7 +9363,7 @@ declare namespace FirebaseFirestore { * @param fieldName Split the value in this field. * @param delimiter Split on this delimiter. * - * @return A new {@code Expression} representing the split function. + * @returns A new {@code Expression} representing the split function. */ export function split( fieldName: string, @@ -9184,7 +9383,7 @@ declare namespace FirebaseFirestore { * @param fieldName Split the value in this field. * @param delimiter Split on this delimiter returned by evaluating this expression. * - * @return A new {@code Expression} representing the split function. + * @returns A new {@code Expression} representing the split function. */ export function split( fieldName: string, @@ -9204,7 +9403,7 @@ declare namespace FirebaseFirestore { * @param expression Split the result of this expression. * @param delimiter Split on this delimiter. * - * @return A new {@code Expression} representing the split function. + * @returns A new {@code Expression} representing the split function. */ export function split( expression: Expression, @@ -9224,7 +9423,7 @@ declare namespace FirebaseFirestore { * @param expression Split the result of this expression. * @param delimiter Split on this delimiter returned by evaluating this expression. * - * @return A new {@code Expression} representing the split function. + * @returns A new {@code Expression} representing the split function. */ export function split( expression: Expression, @@ -9244,7 +9443,7 @@ declare namespace FirebaseFirestore { * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ export function timestampTruncate( fieldName: string, @@ -9265,7 +9464,7 @@ declare namespace FirebaseFirestore { * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ export function timestampTruncate( fieldName: string, @@ -9286,7 +9485,7 @@ declare namespace FirebaseFirestore { * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ export function timestampTruncate( timestampExpression: Expression, @@ -9307,7 +9506,7 @@ declare namespace FirebaseFirestore { * @param granularity The granularity to truncate to. * @param timezone The timezone to use for truncation. Valid values are from * the TZ database (e.g., "America/Los_Angeles") or in the format "Etc/GMT-1". - * @return A new {Expression} representing the truncated timestamp. + * @returns A new {Expression} representing the truncated timestamp. */ export function timestampTruncate( timestampExpression: Expression, @@ -9325,7 +9524,7 @@ declare namespace FirebaseFirestore { * type('title') * ``` * - * @return A new {Expression} representing the data type. + * @returns A new {Expression} representing the data type. */ export function type(fieldName: string): FunctionExpression; /** @@ -9338,14 +9537,14 @@ declare namespace FirebaseFirestore { * type(conditional(exists('foo'), constant(1), constant(true))) * ``` * - * @return A new {Expression} representing the data type. + * @returns A new {Expression} representing the data type. */ export function type(expression: Expression): FunctionExpression; // TODO(new-expression): Add new top-level expression function declarations above this line /** * @beta - * Creates an {@link Ordering} that sorts documents in ascending order based on an expression. + * Creates an `Ordering` that sorts documents in ascending order based on an expression. * * ```typescript * // Sort documents by the 'name' field in lowercase in ascending order @@ -9354,12 +9553,12 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression to create an ascending ordering for. - * @return A new `Ordering` for ascending sorting. + * @returns A new `Ordering` for ascending sorting. */ export function ascending(expr: Expression): Ordering; /** * @beta - * Creates an {@link Ordering} that sorts documents in ascending order based on a field. + * Creates an `Ordering` that sorts documents in ascending order based on a field. * * ```typescript * // Sort documents by the 'name' field in ascending order @@ -9368,12 +9567,12 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The field to create an ascending ordering for. - * @return A new `Ordering` for ascending sorting. + * @returns A new `Ordering` for ascending sorting. */ export function ascending(fieldName: string): Ordering; /** * @beta - * Creates an {@link Ordering} that sorts documents in descending order based on an expression. + * Creates an `Ordering` that sorts documents in descending order based on an expression. * * ```typescript * // Sort documents by the 'name' field in lowercase in descending order @@ -9382,12 +9581,12 @@ declare namespace FirebaseFirestore { * ``` * * @param expr The expression to create a descending ordering for. - * @return A new `Ordering` for descending sorting. + * @returns A new `Ordering` for descending sorting. */ export function descending(expr: Expression): Ordering; /** * @beta - * Creates an {@link Ordering} that sorts documents in descending order based on a field. + * Creates an `Ordering` that sorts documents in descending order based on a field. * * ```typescript * // Sort documents by the 'name' field in descending order @@ -9396,7 +9595,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The field to create a descending ordering for. - * @return A new `Ordering` for descending sorting. + * @returns A new `Ordering` for descending sorting. */ export function descending(fieldName: string): Ordering; /** @@ -9412,7 +9611,7 @@ declare namespace FirebaseFirestore { /** * @beta - * Provides the entry point for defining the data source of a Firestore {@link Pipeline}. + * Provides the entry point for defining the data source of a Firestore `Pipeline`. * * Use the methods of this class (e.g., {@link PipelineSource#collection}, {@link PipelineSource#collectionGroup}, * {@link PipelineSource#database}, or {@link PipelineSource#documents}) to specify the initial data @@ -9427,7 +9626,7 @@ declare namespace FirebaseFirestore { * * @param collectionPath The path to the collection as a string (e.g., 'users/alovelace/chats') * or a {@link CollectionReference} object. - * @returns A new {@link Pipeline} object configured to read from the specified collection. + * @returns A new `Pipeline` object configured to read from the specified collection. * * @example * ```typescript @@ -9451,13 +9650,13 @@ declare namespace FirebaseFirestore { * Specifies the source as a collection group. * * @param collectionId The ID of the collection group. - * @return A new Pipeline object with the collection group as the source. + * @returns A new Pipeline object with the collection group as the source. */ collectionGroup(collectionId: string): Pipeline; /** * @beta - * Creates a new {@link Pipeline} stage that queries all documents belonging to a collection + * Creates a new `Pipeline` stage that queries all documents belonging to a collection * with the ID specified in the provided `options`, regardless of the document's parent. * * A collection group query can be used to query collections that have the same ID but @@ -9469,14 +9668,14 @@ declare namespace FirebaseFirestore { * ``` * * @param options Options defining how this CollectionGroupStage is evaluated, including the `collectionId`. - * @returns A new {@link Pipeline} instance representing the collection group stage. + * @returns A new `Pipeline` instance representing the collection group stage. */ collectionGroup(options: CollectionGroupStageOptions): Pipeline; /** * @beta * Specifies the source as a database. * - * @return A new Pipeline object with the database as the source. + * @returns A new Pipeline object with the database as the source. */ database(): Pipeline; /** @@ -9490,7 +9689,7 @@ declare namespace FirebaseFirestore { * Specifies the source as a set of documents. * * @param docs The document references. - * @return A new Pipeline object with the documents as the source. + * @returns A new Pipeline object with the documents as the source. */ documents(docs: Array): Pipeline; /** @@ -9562,13 +9761,12 @@ declare namespace FirebaseFirestore { * stages or constants. You can use this to create new fields or overwrite existing ones (if there * is name overlaps). * - * The added fields are defined using {@link Selectable}s, which can be: + * The added fields are defined using `Selectable`s, which can be: * - * - {@link Field}: References an existing document field. - * - {@link Expression}: Either a literal value (see {@link Constant}) or a computed value + * - `Field`: References an existing document field. + * - `Expression`: Either a literal value (see {@link constant}) or a computed value * (see {@FunctionExpression}) with an assigned alias using {@link Expression#as}. * - * Example: * * ```typescript * firestore.pipeline().collection("books") @@ -9578,9 +9776,9 @@ declare namespace FirebaseFirestore { * ); * ``` * - * @param field The first field to add to the documents, specified as a {@link Selectable}. - * @param additionalFields Optional additional fields to add to the documents, specified as {@link Selectable}s. - * @return A new Pipeline object with this stage appended to the stage list. + * @param field The first field to add to the documents, specified as a `Selectable`. + * @param additionalFields Optional additional fields to add to the documents, specified as `Selectable`s. + * @returns A new Pipeline object with this stage appended to the stage list. */ addFields(field: Selectable, ...additionalFields: Selectable[]): Pipeline; /** @@ -9591,13 +9789,12 @@ declare namespace FirebaseFirestore { * stages or constants. You can use this to create new fields or overwrite existing ones (if there * is name overlaps). * - * The added fields are defined using {@link Selectable}s, which can be: + * The added fields are defined using `Selectable`s, which can be: * - * - {@link Field}: References an existing document field. - * - {@link Expression}: Either a literal value (see {@link Constant}) or a computed value + * - `Field`: References an existing document field. + * - `Expression`: Either a literal value (see {@link constant}) or a computed value * (see {@FunctionExpression}) with an assigned alias using {@link Expression#as}. * - * Example: * * ```typescript * firestore.pipeline().collection("books") @@ -9608,14 +9805,13 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ addFields(options: AddFieldsStageOptions): Pipeline; /** * @beta * Remove fields from outputs of previous stages. * - * Example: * * ```typescript * firestore.pipeline().collection('books') @@ -9628,7 +9824,7 @@ declare namespace FirebaseFirestore { * * @param fieldValue The first field to remove. * @param additionalFields Optional additional fields to remove. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ removeFields( fieldValue: Field | string, @@ -9642,7 +9838,6 @@ declare namespace FirebaseFirestore { * This is useful for reducing the data transferred, by excluding fields * that are no longer needed after certain pipeline operations. * - * Example: * * ```typescript * firestore.pipeline().collection('books') @@ -9657,9 +9852,9 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object containing the configuration for this stage. - * @param options.fields - An array of field names (strings) or {@link Expression} objects + * @param options.fields - An array of field names (strings) or `Expression` objects * representing the fields to be removed from the output. - * @returns A new {@link Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ removeFields(options: RemoveFieldsStageOptions): Pipeline; @@ -9667,16 +9862,15 @@ declare namespace FirebaseFirestore { * @beta * Selects or creates a set of fields from the outputs of previous stages. * - *

    The selected fields are defined using {@link Selectable} expressions, which can be: + *

    The selected fields are defined using `Selectable` expressions, which can be: * *

      *
    • {@code string}: The name of an existing field.
      • - *
    • {@link Field}: A reference to an existing field.
      • - *
    • {@link Expression}: An expression (e.g., a {@link FunctionExpression}) that represents the result of an expression., + *
    • `Field`: A reference to an existing field.
      • + *
    • `Expression`: An expression (e.g., a {@link FunctionExpression}) that represents the result of an expression., * The Expression must be aliased using {@link Expression#as}.
      • *
    * - *

    Example: * * ```typescript * firestore.pipeline().collection("books") @@ -9688,10 +9882,10 @@ declare namespace FirebaseFirestore { * ``` * * @param selection The first field to include in the output documents, specified as a {@link - * Selectable} expression or a string value representing the field name. + * Pipelines.Selectable} expression or a string value representing the field name. * @param additionalSelections Optional additional fields to include in the output documents, specified as {@link - * Selectable} expressions or {@code string} values representing field names. - * @return A new Pipeline object with this stage appended to the stage list. + * Pipelines.Selectable} expressions or {@code string} values representing field names. + * @returns A new Pipeline object with this stage appended to the stage list. */ select( selection: Selectable | string, @@ -9702,12 +9896,12 @@ declare namespace FirebaseFirestore { * @beta * Selects or creates a set of fields from the outputs of previous stages. * - *

    The selected fields are defined using {@link Selectable} expressions, which can be: + *

    The selected fields are defined using `Selectable` expressions, which can be: * *

      *
    • {@code string}: The name of an existing field.
      • - *
    • {@link Field}: A reference to an existing field.
      • - *
    • {@link Expression}: An expression (e.g., a {@link FunctionExpression}) that represents the result of an expression., + *
    • `Field`: A reference to an existing field.
      • + *
    • `Expression`: An expression (e.g., a {@link FunctionExpression}) that represents the result of an expression., * The Expression must be aliased using {@link Expression#as}.
      • *
    * @@ -9715,7 +9909,6 @@ declare namespace FirebaseFirestore { * the output of this stage will be an empty document. If the intention is to add new fields * without replacing existing ones, consider using {@link Pipeline#addFields} instead. * - * Example: * * ```typescript * db.pipeline().collection("books") @@ -9729,8 +9922,8 @@ declare namespace FirebaseFirestore { * ``` * * @param options An object of type {@link SelectStageOptions} that defines the selection criteria for this stage. - * It is expected to contain a `fields` property, which is an array of {@link Selectable} expressions. - * @return A new {@link Pipeline} object with this select stage appended to its list of stages. + * It is expected to contain a `fields` property, which is an array of `Selectable` expressions. + * @returns A new `Pipeline` object with this select stage appended to its list of stages. */ select(options: SelectStageOptions): Pipeline; /** @@ -9750,7 +9943,6 @@ declare namespace FirebaseFirestore { * Function#arrayContains}, etc. * * - *

    Example: * * ```typescript * firestore.pipeline().collection("books") @@ -9762,8 +9954,8 @@ declare namespace FirebaseFirestore { * ); * ``` * - * @param condition The {@link BooleanExpression} to apply. - * @return A new Pipeline object with this stage appended to the stage list. + * @param condition The `BooleanExpression` to apply. + * @returns A new Pipeline object with this stage appended to the stage list. */ where(condition: BooleanExpression): Pipeline; /** @@ -9783,7 +9975,6 @@ declare namespace FirebaseFirestore { * Function#arrayContains}, etc. * * - *

    Example: * * ```typescript * firestore.pipeline().collection("books") @@ -9795,8 +9986,8 @@ declare namespace FirebaseFirestore { * }); * ``` * - * @param options An object that specifies the filtering criteria. It is expected to contain a `filter` property of type {@link BooleanExpression}. - * @return A new Pipeline object with this stage appended to the stage list. + * @param options An object that specifies the filtering criteria. It is expected to contain a `filter` property of type `BooleanExpression`. + * @returns A new Pipeline object with this stage appended to the stage list. */ where(options: WhereStageOptions): Pipeline; /** @@ -9804,10 +9995,9 @@ declare namespace FirebaseFirestore { * Skips the first `offset` number of documents from the results of previous stages. * *

    This stage is useful for implementing pagination in your pipelines, allowing you to retrieve - * results in chunks. It is typically used in conjunction with {@link #limit} to control the + * results in chunks. It is typically used in conjunction with `limit` to control the * size of each page. * - *

    Example: * * ```typescript * // Retrieve the second page of 20 results @@ -9818,7 +10008,7 @@ declare namespace FirebaseFirestore { * ``` * * @param offset The number of documents to skip. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ offset(offset: number): Pipeline; @@ -9830,7 +10020,6 @@ declare namespace FirebaseFirestore { * retrieve results in manageable chunks. It is commonly used alongside {@link Pipeline.limit} * to define the size of each page. * - * Example: * ```typescript * // Retrieve the second page of 20 results * firestore.pipeline().collection('books') @@ -9852,13 +10041,12 @@ declare namespace FirebaseFirestore { * a potentially large result set. It's often used for: * *

      - *
    • **Pagination:** In combination with {@link #offset} to retrieve specific pages of + *
    • **Pagination:** In combination with `offset` to retrieve specific pages of * results.
      • *
    • **Limiting Data Retrieval:** To prevent excessive data transfer and improve performance, * especially when dealing with large collections.
      • *
    * - *

    Example: * * ```typescript * // Limit the results to the top 10 highest-rated books @@ -9868,7 +10056,7 @@ declare namespace FirebaseFirestore { * ``` * * @param limit The maximum number of documents to return. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ limit(limit: number): Pipeline; @@ -9880,13 +10068,12 @@ declare namespace FirebaseFirestore { * a potentially large result set. It's often used for: * *

      - *
    • Pagination: In combination with {@link #offset} to retrieve specific pages of + *
    • Pagination: In combination with `offset` to retrieve specific pages of * results.
      • *
    • Limiting Data Retrieval: To prevent excessive data transfer and improve performance, * especially when dealing with large collections.
      • *
    * - *

    Example: * * ```typescript * // Limit the results to the top 10 highest-rated books @@ -9896,7 +10083,7 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies the limit. It must contain a `limit` property, which is a number representing the maximum number of documents to return. - * @return A new {@link Pipeline} object with this stage appended to the stage list. + * @returns A new `Pipeline` object with this stage appended to the stage list. */ limit(options: LimitStageOptions): Pipeline; /** @@ -9904,16 +10091,15 @@ declare namespace FirebaseFirestore { * Returns a set of distinct values from the inputs to this stage. * * This stage runs through the results from previous stages to include only results with - * unique combinations of {@link Expression} values ({@link Field}, {@link Function}, etc). + * unique combinations of `Expression` values. * - * The parameters to this stage are defined using {@link Selectable} expressions or strings: + * The parameters to this stage are defined using `Selectable` expressions or strings: * * - {@code string}: Name of an existing field - * - {@link Field}: References an existing document field. - * - {@link AliasedExpression}: Represents the result of a function with an assigned alias name + * - `Field`: References an existing document field. + * - `AliasedExpression`: Represents the result of a function with an assigned alias name * using {@link Expression#as}. * - * Example: * * ```typescript * // Get a list of unique author names in uppercase and genre combinations. @@ -9922,11 +10108,11 @@ declare namespace FirebaseFirestore { * .select("authorName"); * ``` * - * @param group The {@link Selectable} expression or field name to consider when determining + * @param group The `Selectable` expression or field name to consider when determining * distinct value combinations. - * @param additionalGroups Optional additional {@link Selectable} expressions to consider when determining distinct + * @param additionalGroups Optional additional `Selectable` expressions to consider when determining distinct * value combinations or strings representing field names. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ distinct( group: string | Selectable, @@ -9937,16 +10123,15 @@ declare namespace FirebaseFirestore { * Returns a set of distinct values from the inputs to this stage. * * This stage runs through the results from previous stages to include only results with - * unique combinations of {@link Expression} values ({@link Field}, {@link Function}, etc). + * unique combinations of `Expression` values (`Field`, {@link Function}, etc). * - * The parameters to this stage are defined using {@link Selectable} expressions or strings: + * The parameters to this stage are defined using `Selectable` expressions or strings: * * - {@code string}: Name of an existing field - * - {@link Field}: References an existing document field. - * - {@link AliasedExpression}: Represents the result of a function with an assigned alias name + * - `Field`: References an existing document field. + * - `AliasedExpression`: Represents the result of a function with an assigned alias name * using {@link Expression#as}. * - * Example: * * ```typescript * // Get a list of unique author names in uppercase and genre combinations. @@ -9956,7 +10141,7 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ distinct(options: DistinctStageOptions): Pipeline; /** @@ -9964,10 +10149,9 @@ declare namespace FirebaseFirestore { * Performs aggregation operations on the documents from previous stages. * *

    This stage allows you to calculate aggregate values over a set of documents. You define the - * aggregations to perform using {@link AliasedAggregate} expressions which are typically results of - * calling {@link Expression#as} on {@link AggregateFunction} instances. + * aggregations to perform using `AliasedAggregate` expressions which are typically results of + * calling {@link Expression#as} on `AggregateFunction` instances. * - *

    Example: * * ```typescript * // Calculate the average rating and the total number of books @@ -9978,11 +10162,11 @@ declare namespace FirebaseFirestore { * ); * ``` * - * @param accumulator The first {@link AliasedAggregate}, wrapping an {@link AggregateFunction} + * @param accumulator The first `AliasedAggregate`, wrapping an `AggregateFunction` * and providing a name for the accumulated results. - * @param additionalAccumulators Optional additional {@link AliasedAggregate}, each wrapping an {@link AggregateFunction} + * @param additionalAccumulators Optional additional `AliasedAggregate`, each wrapping an `AggregateFunction` * and providing a name for the accumulated results. - * @return A new Pipeline object with this stage appended to the stage list. + * @returns A new Pipeline object with this stage appended to the stage list. */ aggregate( accumulator: AliasedAggregate, @@ -10001,12 +10185,11 @@ declare namespace FirebaseFirestore { * If no grouping fields are provided, a single group containing all documents is used. Not * specifying groups is the same as putting the entire inputs into one group. *

  • **Accumulators:** One or more accumulation operations to perform within each group. These - * are defined using {@link AliasedAggregate} expressions, which are typically created by - * calling {@link Expression#as} on {@link AggregateFunction} instances. Each aggregation + * are defined using `AliasedAggregate` expressions, which are typically created by + * calling {@link Expression#as} on `AggregateFunction` instances. Each aggregation * calculates a value (e.g., sum, average, count) based on the documents within its group.
    • * * - *

    Example: * * ```typescript * // Calculate the average rating for each genre. @@ -10018,7 +10201,7 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage + * @returns A new {@code Pipeline} object with this stage appended to the stage * list. */ aggregate(options: AggregateStageOptions): Pipeline; @@ -10028,7 +10211,6 @@ declare namespace FirebaseFirestore { * K-nearest documents based on the specified query `vectorValue` and `distanceMeasure`. The * returned documents will be sorted in order from nearest to furthest from the query `vectorValue`. * - *

    Example: * * ```typescript * // Find the 10 most similar books based on the book description. @@ -10046,7 +10228,7 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ findNearest(options: FindNearestStageOptions): Pipeline; @@ -10057,7 +10239,6 @@ declare namespace FirebaseFirestore { *

    This stage allows you to emit a map value as a document. Each key of the map becomes a field * on the document that contains the corresponding value. * - *

    Example: * * ```typescript * // Input. @@ -10080,7 +10261,7 @@ declare namespace FirebaseFirestore { * ``` * * @param fieldName The name of the field containing the nested map. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ replaceWith(fieldName: string): Pipeline; @@ -10089,10 +10270,9 @@ declare namespace FirebaseFirestore { * Fully replaces all fields in a document with the fields from a map expression. * *

    This stage allows you to transform the current document into a new one - * by providing an {@link Expression} that evaluates to a map. Each key-value pair + * by providing an `Expression` that evaluates to a map. Each key-value pair * in the resulting map will become a field-value pair in the document. * - *

    Example: * * ```typescript * // Input document: @@ -10117,8 +10297,8 @@ declare namespace FirebaseFirestore { * // } * ``` * - * @param expr An {@link Expression} that evaluates to a map. The key-value pairs of this map will replace the document's fields. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @param expr An `Expression` that evaluates to a map. The key-value pairs of this map will replace the document's fields. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ replaceWith(expr: Expression): Pipeline; @@ -10132,7 +10312,6 @@ declare namespace FirebaseFirestore { * corresponding value. Values within the map can be literal values or * expressions that refer to fields from the input document. * - *

    Example: * * ```typescript * // Input document: @@ -10167,7 +10346,7 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies the map expression to use for replacement. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ replaceWith(options: ReplaceWithStageOptions): Pipeline; @@ -10186,7 +10365,7 @@ declare namespace FirebaseFirestore { * ``` * * @param documents The maximum number of documents to sample. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ sample(documents: number): Pipeline; /** @@ -10207,7 +10386,7 @@ declare namespace FirebaseFirestore { * .sample({ percentage: 0.5 }); * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ sample(options: SampleStageOptions): Pipeline; /** @@ -10218,7 +10397,6 @@ declare namespace FirebaseFirestore { * from previous stage of the `other` {@code Pipeline} given in parameter. The order of documents * emitted from this stage is undefined. * - *

    Example: * * ```typescript * // Emit documents from books collection and magazines collection. @@ -10227,7 +10405,7 @@ declare namespace FirebaseFirestore { * ``` * * @param other The other {@code Pipeline} that is part of union. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ union(other: Pipeline): Pipeline; /** @@ -10238,7 +10416,6 @@ declare namespace FirebaseFirestore { * from previous stage of the `other` {@code Pipeline} given in parameter. The order of documents * emitted from this stage is undefined. * - *

    Example: * * ```typescript * // Emit documents from books collection and magazines collection. @@ -10247,7 +10424,7 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ union(options: UnionStageOptions): Pipeline; /** @@ -10263,7 +10440,6 @@ declare namespace FirebaseFirestore { * * No documents are emitted when `selectable` evaluates to an empty array. * - * Example: * * ```typescript * // Input: @@ -10281,7 +10457,7 @@ declare namespace FirebaseFirestore { * * @param selectable A selectable expression defining the field to unnest and the alias to use for each un-nested element in the output documents. * @param indexField An optional string value specifying the field path to write the offset (starting at zero) into the array the un-nested element is from - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ unnest(selectable: Selectable, indexField?: string): Pipeline; /** @@ -10297,7 +10473,6 @@ declare namespace FirebaseFirestore { * * No documents are emitted when `selectable` evaluates to an empty array. * - * Example: * * ```typescript * // Input: @@ -10314,12 +10489,12 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ unnest(options: UnnestStageOptions): Pipeline; /** * @beta - * Sorts the documents from previous stages based on one or more {@link Ordering} criteria. + * Sorts the documents from previous stages based on one or more `Ordering` criteria. * *

    This stage allows you to order the results of your pipeline. You can specify multiple {@link * Ordering} instances to sort by multiple fields in ascending or descending order. If documents @@ -10327,7 +10502,6 @@ declare namespace FirebaseFirestore { * all orderings result in equal comparison, the documents are considered equal and the order is * unspecified. * - *

    Example: * * ```typescript * // Sort books by rating in descending order, and then by title in ascending order for books @@ -10339,14 +10513,14 @@ declare namespace FirebaseFirestore { * ); * ``` * - * @param ordering The first {@link Ordering} instance specifying the sorting criteria. - * @param additionalOrderings Optional additional {@link Ordering} instances specifying the additional sorting criteria. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @param ordering The first `Ordering` instance specifying the sorting criteria. + * @param additionalOrderings Optional additional `Ordering` instances specifying the additional sorting criteria. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ sort(ordering: Ordering, ...additionalOrderings: Ordering[]): Pipeline; /** * @beta - * Sorts the documents from previous stages based on one or more {@link Ordering} criteria. + * Sorts the documents from previous stages based on one or more `Ordering` criteria. * *

    This stage allows you to order the results of your pipeline. You can specify multiple {@link * Ordering} instances to sort by multiple fields in ascending or descending order. If documents @@ -10354,7 +10528,6 @@ declare namespace FirebaseFirestore { * all orderings result in equal comparison, the documents are considered equal and the order is * unspecified. * - *

    Example: * * ```typescript * // Sort books by rating in descending order, and then by title in ascending order for books @@ -10367,7 +10540,7 @@ declare namespace FirebaseFirestore { * ``` * * @param options - An object that specifies required and optional parameters for the stage. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ sort(options: SortStageOptions): Pipeline; /** @@ -10389,7 +10562,7 @@ declare namespace FirebaseFirestore { * * @param name The unique name of the raw stage to add. * @param params A list of parameters to configure the raw stage's behavior. - * @return A new {@code Pipeline} object with this stage appended to the stage list. + * @returns A new {@code Pipeline} object with this stage appended to the stage list. */ rawStage(name: string, params: any[]): Pipeline; /** @@ -10399,21 +10572,20 @@ declare namespace FirebaseFirestore { *

    The returned Promise can be used to track the progress of the pipeline execution * and retrieve the results (or handle any errors) asynchronously. * - *

    The pipeline results are returned in a {@link PipelineSnapshot} object, which contains a list of - * {@link PipelineResult} objects. Each {@link PipelineResult} typically represents a single key/value map that + *

    The pipeline results are returned in a `PipelineSnapshot` object, which contains a list of + * `PipelineResult` objects. Each `PipelineResult` typically represents a single key/value map that * has passed through all the stages of the pipeline, however this might differ depending on the stages involved * in the pipeline. For example: * *

      - *
    • If there are no stages or only transformation stages, each {@link PipelineResult} + *
    • If there are no stages or only transformation stages, each `PipelineResult` * represents a single document.
      • - *
    • If there is an aggregation, only a single {@link PipelineResult} is returned, + *
    • If there is an aggregation, only a single `PipelineResult` is returned, * representing the aggregated results over the entire dataset .
      • - *
    • If there is an aggregation stage with grouping, each {@link PipelineResult} represents a + *
    • If there is an aggregation stage with grouping, each `PipelineResult` represents a * distinct group and its associated aggregated values.
      • *
    * - *

    Example: * * ```typescript * const futureResults = await firestore.pipeline().collection("books") @@ -10423,7 +10595,7 @@ declare namespace FirebaseFirestore { * ``` * * @param pipelineExecuteOptions - Optionally specify pipeline execution behavior. - * @return A Promise representing the asynchronous pipeline execution. + * @returns A Promise representing the asynchronous pipeline execution. */ execute( pipelineExecuteOptions?: PipelineExecuteOptions, @@ -10431,9 +10603,9 @@ declare namespace FirebaseFirestore { /** * @beta - * Executes this pipeline and streams the results as {@link PipelineResult}s. + * Executes this pipeline and streams the results as `PipelineResult`s. * - * @returns {NodeJS.ReadableStream} A Node.js ReadableStream that emits {@link PipelineResult} objects. + * @returns {NodeJS.ReadableStream} A Node.js ReadableStream that emits `PipelineResult` objects. * * @example * ```typescript @@ -10625,7 +10797,7 @@ declare namespace FirebaseFirestore { export type AddFieldsStageOptions = StageOptions & { /** * @beta - * The fields to add to each document, specified as a {@link Selectable}. + * The fields to add to each document, specified as a `Selectable`. * At least one field is required. */ fields: Selectable[]; @@ -10648,7 +10820,7 @@ declare namespace FirebaseFirestore { export type SelectStageOptions = StageOptions & { /** * @beta - * The fields to include in the output documents, specified as {@link Selectable} expression + * The fields to include in the output documents, specified as `Selectable` expression * or as a string value indicating the field name. */ selections: Array; @@ -10660,7 +10832,7 @@ declare namespace FirebaseFirestore { export type WhereStageOptions = StageOptions & { /** * @beta - * The {@link BooleanExpression} to apply as a filter for each input document to this stage. + * The `BooleanExpression` to apply as a filter for each input document to this stage. */ condition: BooleanExpression; }; @@ -10693,7 +10865,7 @@ declare namespace FirebaseFirestore { export type DistinctStageOptions = StageOptions & { /** * @beta - * The {@link Selectable} expressions or field names to consider when determining + * The `Selectable` expressions or field names to consider when determining * distinct value combinations (groups). */ groups: Array; @@ -10705,26 +10877,26 @@ declare namespace FirebaseFirestore { export type AggregateStageOptions = StageOptions & { /** * @beta - * The {@link AliasedAggregate} values specifying aggregate operations to + * The `AliasedAggregate` values specifying aggregate operations to * perform on the input documents. */ accumulators: AliasedAggregate[]; /** * @beta - * The {@link Selectable} expressions or field names to consider when determining + * The `Selectable` expressions or field names to consider when determining * distinct value combinations (groups), which will be aggregated over. */ groups?: Array; }; /** * @beta - * Options defining how a FindNearestStage is evaluated. See {@link Pipeline.findNearest}. + * Options defining how a FindNearestStage is evaluated. See {@link Pipeline.findNearest:VectorQueryOptions}. */ export type FindNearestStageOptions = StageOptions & { /** * @beta * Specifies the field to be used. This can be a string representing the field path - * (e.g., 'fieldName', 'nested.fieldName') or an object of type {@link Field} + * (e.g., 'fieldName', 'nested.fieldName') or an object of type `Field` * representing a more complex field expression. */ field: Field | string; @@ -10763,7 +10935,7 @@ declare namespace FirebaseFirestore { export type ReplaceWithStageOptions = StageOptions & { /** * @beta - * The name of a field that contains a map or an {@link Expression} that + * The name of a field that contains a map or an `Expression` that * evaluates to a map. */ map: Expression | string; @@ -10855,7 +11027,7 @@ declare namespace FirebaseFirestore { /** * @beta - * Represents the explanation statistics for a {@link Pipeline} query execution. + * Represents the explanation statistics for a `Pipeline` query execution. * These statistics are available when the query is executed with explain or analyze * options enabled, providing insights into the query's performance and execution plan. */ @@ -10885,7 +11057,7 @@ declare namespace FirebaseFirestore { * @beta * Represents the results of a Firestore pipeline execution. * - * A `PipelineSnapshot` contains zero or more {@link PipelineResult} objects + * A `PipelineSnapshot` contains zero or more `PipelineResult` objects * representing the documents returned by a pipeline query. It provides methods * to iterate over the documents and access metadata about the query results. * @@ -10932,7 +11104,7 @@ declare namespace FirebaseFirestore { /** * @beta * A PipelineResult contains data read from a Firestore Pipeline. The data can be extracted with the - * {@link #data()} or {@link #get(String)} methods. + * `data()` or `get(String)` methods. * *

    If the PipelineResult represents a non-document result, `ref` will return a undefined * value. diff --git a/types/v1/firestore_admin_client.d.ts b/types/v1/firestore_admin_client.d.ts index ed23c84ae..1682d7605 100644 --- a/types/v1/firestore_admin_client.d.ts +++ b/types/v1/firestore_admin_client.d.ts @@ -1971,7 +1971,7 @@ export declare class FirestoreAdminClient { * * The second parameter to the callback is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. - * @return {Promise} - The promise which resolves to an array. + * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * The promise has a method named "cancel" which cancels the ongoing API call. @@ -2054,7 +2054,7 @@ export declare class FirestoreAdminClient { * details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. - * @return {Promise} - The promise which resolves when API call finishes. + * @returns {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * @@ -2094,7 +2094,7 @@ export declare class FirestoreAdminClient { * for the details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. - * @return {Promise} - The promise which resolves when API call finishes. + * @returns {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. *