firebase-functions package

関数

関数 説明
config() サードパーティの API キーやその他の設定などのプロジェクト構成データを保存および取得します。Firebase CLI を使用して構成値を設定できます。詳細については、[環境構成](/docs/functions/config-env)をご覧ください。
optionsToEndpoint(options)
optionsToTrigger(options)
region（regions） 関数をデプロイするリージョンを構成します。
runWith(runtimeOptions) 関数のランタイム オプションを構成します。

クラス

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

インターフェース

インターフェース 説明
BlockingFunction Auth ブロック トリガーの関数タイプ。
Cloud Functions HTTPS 以外のすべてのトリガーの関数タイプ。Cloud Functions の関数を定義するには、JavaScript ファイルからエクスポートする必要があります。この型は、テンプレート化された Event オブジェクトを唯一の引数として受け取る特別な JavaScript 関数です。
DeploymentOptions 関数のデプロイ時に適用される関数の構成オプション。
イベント イベントの送信形式。
EventContext イベントが発生したコンテキスト。
FailurePolicy バックグラウンド関数の障害ポリシーの構成オプション。
HttpsFunction HTTPS トリガーの関数タイプ。Cloud Functions の関数を定義するには、これを JavaScript ファイルからエクスポートする必要があります。
リソース Resource は、リソースを定義するための標準形式です（google.rpc.context.AttributeContext.Resource）。Cloud Functions では、ストレージ バケットなど、関数をトリガーしたリソースです。
実行可能 Runnable には、ユーザー定義関数を直接呼び出す run メソッドがあり、単体テストに便利です。
RuntimeOptions 実行時に適用される関数の構成オプション。
スケジュール スケジュール設定された関数の構成オプション。
ScheduleRetryConfig スケジューラの再試行オプション。スケジュール設定された関数にのみ適用されます。

名前空間

名前空間 説明
アナリティクス
認証
データベース
firestore
https
ロガー
params
Pub/Sub
remoteConfig
ストレージ
タスク
testLab

変数

変数 説明
アプリ
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS IngressSettings で使用可能なオプションのリスト。
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Cloud Functions の最大タイムアウト値。
MIN_TIMEOUT_SECONDS Cloud Functions の関数の最小タイムアウト値。
リセット値 設定をプラットフォームのデフォルトにリセットするための特別な設定値。
SUPPORTED_REGIONS Cloud Functions でサポートされているすべてのリージョンのリスト。
VALID_MEMORY_OPTIONS Cloud Functions でサポートされているメモリ オプションのリスト。
VPC_EGRESS_SETTINGS_OPTIONS VpcConnectorEgressSettings で使用可能なオプションのリスト。

config()

サードパーティの API キーやその他の設定などのプロジェクト構成データを保存および取得します。Firebase CLI を使用して構成値を設定できます。詳細については、[環境構成](/docs/functions/config-env)をご覧ください。

署名:

export declare function config(): Record<string, any>;

戻り値:

レコード<文字列、任意>

optionsToEndpoint()

署名:

export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

パラメータ

パラメータ 型 説明
オプション DeploymentOptions

戻り値:

ManifestEndpoint

optionsToTrigger()

署名:

export declare function optionsToTrigger(options: DeploymentOptions): any;

パラメータ

パラメータ 型 説明
オプション DeploymentOptions

戻り値:

任意

region()

関数をデプロイするリージョンを構成します。

署名:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

パラメータ

パラメータ 型 説明
リージョン 配列<(typeof SUPPORTED_REGIONS)[number] |文字列 |式<string>|ResetValue> 1 つ以上の地域文字列。

戻り値:

FunctionBuilder

例 1

functions.region('us-east1')

例 2

functions.region('us-east1', 'us-central1')

runWith()

関数のランタイム オプションを構成します。

署名:

export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

パラメータ

パラメータ 型 説明
runtimeOptions RuntimeOptions オプション フィールドを含むオブジェクト: 1.memory: 関数に割り当てるメモリの量。有効な値は、128MB、256MB、512MB、1GB、2GB、4GB、8GB です。2. timeoutSeconds: 関数のタイムアウト（秒単位）。有効な値は 0 ～ 540 です。3. failurePolicy: 関数の失敗ポリシー。ブール値 true は空の再試行オブジェクトを提供するのと同等です。4. vpcConnector: 同じプロジェクトとリージョン内の VPC コネクタの ID。5. vpcConnectorEgressSettings: vpcConnector が設定されている場合、vpcConnector を介して送信する下り（外向き）トラフィックを制御します。6. serviceAccount: 関数の特定のサービス アカウント。7. ingressSettings: 関数の上り（内向き）設定。これにより、HTTPS 関数を呼び出せる場所を制御します。値を null にすることはできません。

戻り値:

FunctionBuilder

アプリ

署名:

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

MAX_TIMEOUT_SECONDS

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