firebase-admin.functions package

Firebase 函式服務。

函式

函式	說明
getFunctions(應用程式)	取得預設應用程式或特定應用程式的函式服務。getFunctions() 可以在沒有引數的情況下呼叫 getFunctions()，藉此存取預設應用程式的 Functions 服務，也可當做 getFunctions(app) 以存取與特定應用程式相關聯的 Functions 服務。

等級

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

介面

介面	說明
AbsoluteDelivery	代表工作選項的介面，提供絕對放送。
DelayDelivery	代表工作選項延遲送達的介面。
curlExperimental	代表實驗性 (Beta 版) 工作選項的類型。

類型別名

類型別名	說明
DeliverySchedule	代表放送排程選項的類型。DeliverySchedule 是 DelayDelivery 和 AbsoluteDelivery 類型的聯集類型。
drawable	代表工作選項的類型。

getFunctions(應用程式)

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

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

簽名：

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

參數

參數	類型	說明
app	應用程式	用於傳回 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>;
};