firebase-functions package

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

関数

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

クラス

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

インターフェース

インターフェース 説明
CloudEvent （ベータ版）CloudEventBase は、サーバーレス イベントをエンコードするためのクロス プラットフォーム形式のベースです。詳細については、https://github.com/cloudevents/spec をご覧ください。
Cloud Functions （ベータ版） CloudEvents のハンドラ。
EventHandlerOptions イベント処理関数で設定できる追加のフィールド。
GlobalOptions GlobalOptions は、プロジェクト全体に設定できるオプションです。これらのオプションは、HTTPS とイベント処理関数に共通です。

名前空間

名前空間 説明
アラート
データベース
eventarc
firestore
https
ID
ロガー
params
Pub/Sub
remoteConfig
スケジューラ
ストレージ
タスク
testLab

型エイリアス

型エイリアス 説明
IngressSetting IngressSettings で使用可能なオプションのリスト。
MemoryOption Cloud Functions でサポートされているメモリ オプションのリスト。
ParamsOf すべてのパラメータ キャプチャ グループをレコードのキーにマッピングする型。例: ParamsOf<"users/{uid}">は { uid: string } ParamsOf<"users/{uid}/logs/{log}">is { uid: string;log: string } ParamsOf<"some/static/data">は {} です柔軟性の理由から、ParamsOf は Record<string, string> です
SupportedRegion Cloud Functions（第 2 世代）でサポートされているすべてのリージョンのリスト。
VpcEgressSetting VpcConnectorEgressSettings で使用可能なオプションのリスト。

setGlobalOptions()

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

署名:

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

パラメータ

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

戻り値:

void

IngressSetting

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<"users/{uid}">は { uid: string } ParamsOf<"users/{uid}/logs/{log}">is { uid: string;log: string } ParamsOf<"some/static/data">{} です

柔軟性の理由から、ParamsOf は Record<string, string> とします。

署名:

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";

VpcEgressSetting

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

署名:

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