功能
功能 | 描述 |
---|---|
配置() | 儲存和檢索項目配置數據,例如第三方 API 金鑰或其他設定。您可以使用 Firebase CLI 設定設定值,如[環境設定](/docs/functions/config-env)所述。 |
選項到端點(選項) | |
觸發選項(選項) | |
地區(地區) | 配置功能部署到的區域。 |
runWith(運行時選項) | 配置函數的運行時選項。 |
課程
班級 | 描述 |
---|---|
改變 | 用於更改狀態的事件的 Cloud Functions 接口,例如即時資料庫或 Cloud Firestore onWrite 和onUpdate 事件。有關用於構造Change 物件的格式的更多信息,請參閱下文。 |
函數產生器 |
介面
介面 | 描述 |
---|---|
阻塞功能 | 身份驗證阻止觸發器的功能類型。 |
雲函數 | 所有非 HTTPS 觸發器的函數類型。這應該從您的 JavaScript 檔案匯出以定義雲端函數。這種類型是一個特殊的 JavaScript 函數,它將模板化的Event 物件作為其唯一的參數。 |
部署選項 | 在功能部署期間套用的功能的配置選項。 |
事件 | 事件的有線格式。 |
事件情境 | 事件發生的上下文。 |
失敗策略 | 後台功能故障策略的配置選項。 |
Https函數 | HTTPS 觸發器的函數類型。這應該從您的 JavaScript 檔案匯出以定義雲端函數。 |
資源 | Resource 是定義資源的標準格式 (google.rpc.context.AttributeContext.Resource)。在 Cloud Functions 中,它是觸發函數的資源 - 例如儲存桶。 |
可運行 | Runnable 有一個run 方法,它直接呼叫使用者定義的函數 - 對於單元測試很有用。 |
運行時選項 | 在運行時適用的函數的配置選項。 |
行程 | 預定功能的配置選項。 |
計劃重試配置 | 調度程序重試選項。僅適用於預定功能。 |
命名空間
命名空間 | 描述 |
---|---|
分析 | |
授權 | |
資料庫 | |
火庫 | |
https | |
記錄器 | |
參數 | |
發布訂閱 | |
遠端配置 | |
貯存 | |
任務 | |
測試實驗室 |
變數
多變的 | 描述 |
---|---|
應用程式 | |
DEFAULT_FAILURE_POLICY | |
INGRESS_SETTINGS_OPTIONS | IngressSettings 的可用選項清單。 |
MAX_NUMBER_USER_LABELS 個 | |
最大超時秒數 | Cloud Functions 最大逾時值。 |
MIN_TIMEOUT_SECONDS | Cloud Functions 最短逾時值。 |
重置值 | 用於將配置重設為平台預設值的特殊配置值。 |
支持的_地區 | Cloud Functions 支援的所有區域的清單。 |
VALID_MEMORY_OPTIONS | Cloud Functions 支援的可用記憶體選項清單。 |
VPC_EGRESS_SETTINGS_OPTIONS | VpcConnectorEgressSettings 的可用選項清單。 |
配置()
儲存和檢索項目配置數據,例如第三方 API 金鑰或其他設定。您可以使用 Firebase CLI 設定設定值,如[環境設定](/docs/functions/config-env)所述。
簽名:
export declare function config(): Record<string, any>;
返回:
記錄<字串,任意>
optionsToEndpoint()
簽名:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
參數
範圍 | 類型 | 描述 |
---|---|---|
選項 | 部署選項 |
返回:
清單端點
選項觸發()
簽名:
export declare function optionsToTrigger(options: DeploymentOptions): any;
參數
範圍 | 類型 | 描述 |
---|---|---|
選項 | 部署選項 |
返回:
任何
地區()
配置功能部署到的區域。
簽名:
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
參數
範圍 | 類型 | 描述 |
---|---|---|
地區 | 數組 <( SUPPORTED_REGIONS類型)[數量] |字串|表達<字串> |重置值> | 更多區域字串之一。 |
返回:
實施例1
函數.region('us-east1')
實施例2
函數.region('us-east1', 'us-central1')
運行()
配置函數的運行時選項。
簽名:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
參數
範圍 | 類型 | 描述 |
---|---|---|
運行時選項 | 運行時選項 | 具有可選欄位的物件: 1. memory :分配給函數的記憶體量,可能的值為:'128MB'、'256MB'、'512MB'、'1GB'、'2GB'、'4GB' 和 '8GB' 。 2. timeoutSeconds :函數的逾時時間,單位為秒,可能的值為 0 到 540。3. failurePolicy :函數的失敗策略,boolean true 相當於提供一個空的重試物件。 4. vpcConnector :同專案同地域的VPC連接器的id。 5. vpcConnectorEgressSettings :設定 vpcConnector 時,控制透過 vpcConnector 傳送哪些出口流量。 6. serviceAccount :該功能的特定服務帳戶。 7. ingressSettings :函數的入口設置,控制從何處呼叫 HTTPS 函數。值不能為空。 |
返回:
應用程式
簽名:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
DEFAULT_FAILURE_POLICY
簽名:
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
IngressSettings 的可用選項清單。
簽名:
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAX_NUMBER_USER_LABELS 個
簽名:
MAX_NUMBER_USER_LABELS = 58
最大超時秒數
Cloud Functions 最大逾時值。
簽名:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Cloud Functions 最短逾時值。
簽名:
MIN_TIMEOUT_SECONDS = 0
重置值
用於將配置重設為平台預設值的特殊配置值。
簽名:
RESET_VALUE: ResetValue
支持的_地區
Cloud Functions 支援的所有區域的清單。
簽名:
SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]
VALID_MEMORY_OPTIONS
Cloud Functions 支援的可用記憶體選項清單。
簽名:
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
VpcConnectorEgressSettings 的可用選項清單。
簽名:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]