firebase-functions package

Firebase 向け Cloud Functions の第 2 世代 API。この SDK はディープ インポートをサポートしています。たとえば、名前空間pubsub firebase-functions/v2で利用できるか、 firebase-functions/v2/pubsubから直接インポートできます。

機能

関数説明
setGlobalOptions(オプション)第 2 世代 SDK を使用して作成されたすべての関数のデフォルト オプションを設定します。

クラス

クラス説明
変化Realtime Database や Cloud Firestore のonWriteイベントやonUpdateイベントなど、状態を変更するイベント用の Cloud Functions インターフェース。 Changeオブジェクトの構築に使用される形式の詳細については、以下を参照してください。

インターフェース

インターフェース説明
クラウドイベント(ベータ) CloudEventBase 、サーバーレス イベントをエンコードするためのクロスプラットフォーム形式のベースです。詳細については、https://github.com/cloudevents/spec を参照してください。
クラウドファンクション(ベータ) CloudEvents のハンドラー。
イベントハンドラーオプション任意のイベント処理関数に設定できる追加フィールド。
グローバルオプションGlobalOptions 、プロジェクト全体にわたって設定できるオプションです。これらのオプションは、HTTPS およびイベント処理関数に共通です。

名前空間

名前空間説明
アラート
データベース
イベントアーク
消防署
https
身元
ロガー
パラメータ
パブサブ
リモート構成
スケジューラ
ストレージ
タスク
テストラボ

タイプエイリアス

タイプエイリアス説明
イングレス設定IngressSettingsで使用可能なオプションのリスト。
メモリオプションCloud Functions でサポートされている使用可能なメモリ オプションのリスト。
ParamsOfすべてのパラメータ キャプチャ グループをレコードのキーにマップするタイプ。たとえば、ParamsOf < 「ユーザー/ { UID } > は { uid: string } ParamsOf < 「ユーザー/ { UID } /ログ/ {ログ} > は { uid: 文字列;ログ: 文字列 } < 「一部/静的/データ」 > は { }柔軟性の理由から、ParamsOf記録です<文字列、文字列>
サポートされている地域Cloud Functions (第 2 世代) でサポートされているすべてのリージョンのリスト。
VpcEgress設定VpcConnectorEgressSettingsで使用可能なオプションのリスト。

setGlobalOptions()

第 2 世代 SDK を使用して作成されたすべての関数のデフォルト オプションを設定します。

サイン:

export declare function setGlobalOptions(options: GlobalOptions): void;

パラメーター

パラメータタイプ説明
オプショングローバルオプションデフォルトとして設定するオプション

戻り値:

空所

イングレス設定

IngressSettingsで使用可能なオプションのリスト

サイン:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

メモリオプション

Cloud Functions でサポートされている使用可能なメモリ オプションのリスト。

サイン:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

ParamsOf

すべてのパラメータ キャプチャ グループをレコードのキーにマップするタイプ。たとえば、ParamsOf < 「ユーザー/ { UID } > は { uid: string } ParamsOf < 「ユーザー/ { UID } /ログ/ {ログ} > は { uid: 文字列;ログ: 文字列 } < 「一部/静的/データ」 > は { }

柔軟性の理由から、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";

VpcEgress設定

VpcConnectorEgressSettingsで使用可能なオプションのリスト

サイン:

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";