Functions class
Stay organized with collections
Save and categorize content based on your preferences.
The Firebase Functions service interface.
Signature:
export declare class Functions
Properties
| Property |
Modifiers |
Type |
Description |
| app |
|
App |
|
Methods
| Method |
Modifiers |
Description |
| taskQueue(functionName, extensionId) |
|
Creates a reference to a TaskQueue for a given function name. The function name can be either:1) A fully qualified function resource name: projects/{project}/locations/{location}/functions/{functionName}2) A partial resource name with location and function name, in which case the runtime project ID is used: locations/{location}/functions/{functionName}3) A partial function name, in which case the runtime project ID and the default location, us-central1, is used: {functionName} |
Functions.app
Signature:
readonly app: App;
Functions.taskQueue()
Creates a reference to a TaskQueue for a given function name. The function name can be either:
1) A fully qualified function resource name: projects/{project}/locations/{location}/functions/{functionName}
2) A partial resource name with location and function name, in which case the runtime project ID is used: locations/{location}/functions/{functionName}
3) A partial function name, in which case the runtime project ID and the default location, us-central1, is used: {functionName}
Signature:
taskQueue<Args = Record<string, any>>(functionName: string, extensionId?: string): TaskQueue<Args>;
Parameters
| Parameter |
Type |
Description |
| functionName |
string |
The name of the function. |
| extensionId |
string |
Optional Firebase extension ID. |
Returns:
TaskQueue<Args>
A promise that fulfills with a TaskQueue.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["The Firebase `Functions` service interface.\n\n**Signature:** \n\n export declare class Functions \n\nProperties\n\n| Property | Modifiers | Type | Description |\n|-------------------------------------------------------------|-----------|------|-------------|\n| [app](./firebase-admin.functions.functions.md#functionsapp) | | App | |\n\nMethods\n\n| Method | Modifiers | Description |\n|----------------------------------------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [taskQueue(functionName, extensionId)](./firebase-admin.functions.functions.md#functionstaskqueue) | | Creates a reference to a [TaskQueue](./firebase-admin.functions.taskqueue.md#taskqueue_class) for a given function name. The function name can be either:1) A fully qualified function resource name: `projects/{project}/locations/{location}/functions/{functionName}`2) A partial resource name with location and function name, in which case the runtime project ID is used: `locations/{location}/functions/{functionName}`3) A partial function name, in which case the runtime project ID and the default location, `us-central1`, is used: `{functionName}` |\n\nFunctions.app\n\n**Signature:** \n\n readonly app: App;\n\nFunctions.taskQueue()\n\nCreates a reference to a [TaskQueue](./firebase-admin.functions.taskqueue.md#taskqueue_class) for a given function name. The function name can be either:\n\n1) A fully qualified function resource name: `projects/{project}/locations/{location}/functions/{functionName}`\n\n2) A partial resource name with location and function name, in which case the runtime project ID is used: `locations/{location}/functions/{functionName}`\n\n3) A partial function name, in which case the runtime project ID and the default location, `us-central1`, is used: `{functionName}`\n\n**Signature:** \n\n taskQueue\u003cArgs = Record\u003cstring, any\u003e\u003e(functionName: string, extensionId?: string): TaskQueue\u003cArgs\u003e;\n\nParameters\n\n| Parameter | Type | Description |\n|--------------|--------|---------------------------------|\n| functionName | string | The name of the function. |\n| extensionId | string | Optional Firebase extension ID. |\n\n**Returns:**\n\n[TaskQueue](./firebase-admin.functions.taskqueue.md#taskqueue_class)\\\u003cArgs\\\u003e\n\nA promise that fulfills with a `TaskQueue`."]]
