Back to Firebase Js Sdk

FunctionExpression class

docs-devsite/firestore_pipelines.functionexpression.md

12.12.12.2 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

FunctionExpression class

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.

<b>Signature:</b>

typescript
export declare class FunctionExpression extends Expression 

<b>Extends:</b> Expression

Constructors

ConstructorModifiersDescription
(constructor)(name, params)Constructs a new instance of the <code>FunctionExpression</code> class

Properties

PropertyModifiersTypeDescription
expressionTypeExpressionType

FunctionExpression.(constructor)

Constructs a new instance of the FunctionExpression class

<b>Signature:</b>

typescript
constructor(name: string, params: Expression[]);

Parameters

ParameterTypeDescription
namestring
paramsExpression<!-- -->[]

FunctionExpression.expressionType

<b>Signature:</b>

typescript
readonly expressionType: ExpressionType;