firebase-admin.functions package

Firebase Functions 服務。

函式

函式	說明
getFunctions(應用程式)	取得預設應用程式或特定應用程式的函式服務。無需引數即可呼叫 getFunctions()，藉此存取預設應用程式的 Functions 服務，也可使用 getFunctions(app) 呼叫，來存取與特定應用程式相關聯的 Functions 服務。

類別

類別	說明
函式	Firebase Functions 服務介面。
TaskQueue	TaskQueue 介面。

介面

介面	說明
絕對放送	採用絕對傳遞的工作選項介面。
DelayDelivery	顯示延遲送達的工作選項介面。
競爭實驗	代表實驗性 (Beta 版) 工作選項的類型。

型別別名

類型別名	說明
放送時間表	代表放送時間表選項的類型。DeliverySchedule 是 DelayDelivery 和 AbsoluteDelivery 類型的聯集類型。
投放內容	代表工作選項的類型。

getFunctions(應用程式)

取得預設應用程式或特定應用程式的函式服務。

呼叫 getFunctions() 時無需引數即可存取預設應用程式的 Functions 服務，也可使用 getFunctions(app) 形式呼叫，藉此存取與特定應用程式相關聯的 Functions 服務。

簽名：

export declare function getFunctions(app?: App): Functions;

參數

參數	類型	說明
應用程式	應用程式	用於傳回 Functions 服務的選用應用程式。如未提供，系統會傳回預設的 Functions 服務。

傳回：

函式

如未提供應用程式，或與提供應用程式相關聯的 Functions 服務，則預設的 Functions 服務。

範例 1

// Get the `Functions` service for the default app
const defaultFunctions = getFunctions();

範例 2

// Get the `Functions` service for a given app
const otherFunctions = getFunctions(otherApp);

放送時間表

代表放送時間表選項的類型。DeliverySchedule 是 DelayDelivery 和 AbsoluteDelivery 類型的聯集類型。

簽名：

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

TaskOptions

代表工作選項的類型。

簽名：

export type TaskOptions = DeliverySchedule & TaskOptionsExperimental & {
    dispatchDeadlineSeconds?: number;
    id?: string;
    headers?: Record<string, string>;
};