Represents a parametrized value that will be read from .env files if present, or prompted for by the CLI if missing. Instantiate these with the defineX methods exported by the firebase-functions/params namespace.
Signature:
export declare abstract class Param<T extends string | number | boolean | string[]> extends Expression<T>
Extends: Expression<T>
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(name, options) | Constructs a new instance of the Param class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| name | string | ||
| options | ParamOptions<T> | ||
| type | static |
ParamValueType |
Methods
| Method | Modifiers | Description |
|---|---|---|
| cmp(cmp, rhs) | Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. | |
| equals(rhs) | Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. | |
| greaterThan(rhs) | Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. | |
| greaterThanOrEqualTo(rhs) | Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. | |
| lessThan(rhs) | Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. | |
| lessThanorEqualTo(rhs) | Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. | |
| lessThanOrEqualTo(rhs) | Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. | |
| notEquals(rhs) | Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression. | |
| toString() |
params.Param.(constructor)
Constructs a new instance of the Param class
Signature:
constructor(name: string, options?: ParamOptions<T>);
Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | |
| options | ParamOptions<T> |
params.Param.name
Signature:
readonly name: string;
params.Param.options
Signature:
readonly options: ParamOptions<T>;
params.Param.type
Signature:
static type: ParamValueType;
params.Param.cmp()
Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
Signature:
cmp(cmp: "==" | "!=" | ">" | ">=" | "<" | "<=", rhs: T | Expression<T>): CompareExpression<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| cmp | "==" | "!=" | ">" | ">=" | "<" | "<=" | |
| rhs | T | Expression<T> |
Returns:
CompareExpression<T>
params.Param.equals()
Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
Signature:
equals(rhs: T | Expression<T>): CompareExpression<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| rhs | T | Expression<T> |
Returns:
CompareExpression<T>
params.Param.greaterThan()
Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
Signature:
greaterThan(rhs: T | Expression<T>): CompareExpression<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| rhs | T | Expression<T> |
Returns:
CompareExpression<T>
params.Param.greaterThanOrEqualTo()
Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
Signature:
greaterThanOrEqualTo(rhs: T | Expression<T>): CompareExpression<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| rhs | T | Expression<T> |
Returns:
CompareExpression<T>
params.Param.lessThan()
Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
Signature:
lessThan(rhs: T | Expression<T>): CompareExpression<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| rhs | T | Expression<T> |
Returns:
CompareExpression<T>
params.Param.lessThanorEqualTo()
A typo. Use lessThanOrEqualTo instead.
Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
Signature:
lessThanorEqualTo(rhs: T | Expression<T>): CompareExpression<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| rhs | T | Expression<T> |
Returns:
CompareExpression<T>
params.Param.lessThanOrEqualTo()
Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
Signature:
lessThanOrEqualTo(rhs: T | Expression<T>): CompareExpression<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| rhs | T | Expression<T> |
Returns:
CompareExpression<T>
params.Param.notEquals()
Returns a parametrized expression of Boolean type, based on comparing the value of this parameter to a literal or a different expression.
Signature:
notEquals(rhs: T | Expression<T>): CompareExpression<T>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| rhs | T | Expression<T> |
Returns:
CompareExpression<T>
params.Param.toString()
Signature:
toString(): string;
Returns:
string