This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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 and(), equal(), or the methods on Expression (Expression.equal(), Expression.lessThan(), etc.) to construct new Function instances.
Signature:
export declare class FunctionExpression extends Expression
Extends: Expression
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(name, params) | (Public Preview) Constructs a new instance of the FunctionExpression class |
|
| (constructor)(name, params, _methodName) | (Public Preview) Constructs a new instance of the FunctionExpression class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| expressionType | ExpressionType | (Public Preview) |
FunctionExpression.(constructor)
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Constructs a new instance of the FunctionExpression class
Signature:
constructor(name: string, params: Expression[]);
Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | |
| params | Expression[] |
FunctionExpression.(constructor)
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Constructs a new instance of the FunctionExpression class
Signature:
constructor(name: string, params: Expression[], _methodName: string | undefined);
Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | |
| params | Expression[] | |
| _methodName | string | undefined |
FunctionExpression.expressionType
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Signature:
readonly expressionType: ExpressionType;