Cloud Functions for Firebase 適用的第 2 代 API。這個 SDK 支援深層匯入。舉例來說,可在 firebase-functions/v2
使用命名空間 pubsub
,或是直接從 firebase-functions/v2/pubsub
匯入。
函式
函式 | 說明 |
---|---|
setGlobalOptions(選項) | 為所有使用第 2 代 SDK 編寫的函式設定預設選項。 |
類別
類別 | 說明 |
---|---|
變更 | Cloud Functions 介面適用於會變更狀態的事件,例如即時資料庫或 Cloud Firestore onWrite 和 onUpdate 事件。如要進一步瞭解用於建構 Change 物件的格式,請參閱下方說明。 |
介面
介面 | 說明 |
---|---|
CloudEvent | (Beta 版) CloudEventBase 是將無伺服器事件編碼的跨平台格式基礎。詳情請參閱 https://github.com/cloudevents/spec。 |
CloudFunction | (Beta 版) CloudEvents 的處理常式。 |
EventHandlerOptions | 可針對任何事件處理函式設定的其他欄位。 |
GlobalOptions | GlobalOptions 是可在整個專案中設定的選項。這些選項在 HTTPS 和事件處理函式中很常見。 |
命名空間
命名空間 | 說明 |
---|---|
快訊 | |
資料庫 | |
事件 | |
Firestore | |
https | |
身分識別 | |
記錄程式 | |
參數 | |
發布/訂閱 | |
remoteConfig | |
排程器 | |
儲存空間 | |
工作 | |
testLab |
型別別名
類型別名 | 說明 |
---|---|
輸入設定 | IngressSettings 的可用選項清單。 |
MemoryOption | Cloud Functions 支援的可用記憶體選項清單。 |
參數 | 將所有參數擷取灰色對應至記錄鍵的類型。例如 ParamsOf<"users/{uid}">is { uid: string } ParamsOf<"users/{uid}/logs/{log}">是 { uid: string;log: string } ParamsOf<"some/static/data">為 {}基於彈性考量,ParamsOf |
支援地區 | Cloud Functions (第 2 代) 支援的所有區域清單。 |
VpcegressSetting | 適用於 VpcConnectorEgressSettings 的選項清單。 |
setGlobalOptions()
為所有使用第 2 代 SDK 編寫的函式設定預設選項。
簽名:
export declare function setGlobalOptions(options: GlobalOptions): void;
參數
參數 | 類型 | 說明 |
---|---|---|
選項 | GlobalOptions | 設為預設選項 |
傳回:
void
輸入設定
列出 IngressSettings
的可用選項清單。
簽名:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
MemoryOption
Cloud Functions 支援的可用記憶體選項清單。
簽名:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
參數
將所有參數擷取灰色對應至記錄鍵的類型。例如 ParamsOf<"users/{uid}">is { uid: string } ParamsOf<"users/{uid}/logs/{log}">是 { uid: string;log: string } ParamsOf<"some/static/data">是 {}
為了靈活起見,ParamsOf
簽名:
export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
[Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};
支援地區
Cloud Functions (第 2 代) 支援的所有區域清單。
簽名:
export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";
虛擬私有雲網路輸出設定
列出 VpcConnectorEgressSettings
的可用選項清單。
簽名:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";