functions package

Cloud Functions for Firebase

関数

関数 説明
function(app, ...)
getFunctions(app, regionOrCustomDomain) 指定されたアプリの Functions インスタンスを返します。
function(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, host, port) このインスタンスを変更して、Cloud Functions エミュレータと通信します。注: このインスタンスをオペレーションの実行に使用する前に、このインスタンスを呼び出す必要があります。
httpsCallable(functionsInstance, name, options) 指定された名前の呼び出し可能な HTTPS トリガーへの参照を返します。
httpsCallableFromURL(functionsInstance, url, options) 指定された URL の呼び出し可能な HTTPS トリガーへの参照を返します。

インターフェース

インターフェース 説明
関数 Functions インスタンス。
FunctionsError Firebase Functions クライアント SDK から返されたエラー。
HttpsCallableOptions 呼び出しの実行方法に関するメタデータのインターフェース。
HttpsCallableResult HttpsCallableResult は、関数呼び出しの 1 つの結果をラップします。

型エイリアス

型エイリアス 説明
FunctionsErrorCode Firebase Functions のステータス コードのセット。コードは、gRPC によって公開されているコードと同じです（https://github.com/grpc/grpc/blob/master/doc/statuscodes.md）。有効な値: - 'cancelled': オペレーションはキャンセルされました（通常は呼び出し元によって）。- 'unknown': 不明なエラーまたは別のエラードメインからのエラーです。- 'invalid-argument': クライアントが無効な引数を指定しました。これは「failed-precondition」とは異なることに注意してください。「無効な引数」は、システムの状態に関係なく問題がある引数を示します（無効なフィールド名など）。- 'deadline-exceeded': 操作が完了する前に期限が切れました。システムの状態を変更するオペレーションの場合、オペレーションが正常に終了しても、このエラーが返されることがあります。たとえば、サーバーからの正常なレスポンスが、期限切れになるほど遅延していた可能性があります。- 'not-found': リクエストされたドキュメントは見つかりませんでした。- 'Already-exists': 作成しようとしたドキュメントがすでに存在します。- 'permission-denied': 呼び出し元には、指定された操作を実行する権限がありません。- 'resource-exhausted': 一部のリソースが不足しています。ユーザーごとの割り当て、またはファイル システム全体で容量が不足している可能性があります。- 'failed-precondition': システムがオペレーションの実行に必要な状態ではないため、オペレーションが拒否されました。- 'aborted': オペレーションは中止されました。通常は、トランザクションの中止などの同時実行の問題が原因です。- 'out-of-range': オペレーションが有効な範囲を超えて試行されました。- 'unImplemented': オペレーションが実装されていないか、サポートまたは有効化されていません。- 'internal': 内部エラーです。基になるシステムで予期される一部の不変条件が破損していることを意味します。これらのエラーのいずれかが表示される場合、何かが著しく壊れています。- 「unavailable」: サービスは現在利用できません。これは一時的な状態である可能性が高く、バックオフで再試行することで修正できます。- 'data-loss': 回復不能なデータの損失または破損。- 'unauthenticated': リクエストに、操作のための有効な認証情報がありません。
FunctionsErrorCodeCore 「functions/」の後に追加された関数のエラーコードの文字列です。コードの詳細については、FunctionsErrorCode をご覧ください。
HttpsCallable "callable" への参照。Google Cloud Functions での HTTP トリガー。

関数（アプリ、...）

getFunctions(app, regionOrCustomDomain)

指定されたアプリの Functions インスタンスを返します。

署名:

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

パラメータ

パラメータ 型 説明
アプリ FirebaseApp 使用する FirebaseApp。
regionOrCustomDomain 文字列 次のいずれか: a）呼び出し可能関数が配置されているリージョン（例: us-central1） b）呼び出し可能関数をホストするカスタム ドメイン（例: https://mydomain.com）

戻り値:

関数

function(functionsInstance, ...)

connectFunctionsEmulator(functionsInstance, host, port)

このインスタンスを変更して、Cloud Functions エミュレータと通信します。

署名:

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

パラメータ

パラメータ 型 説明
関数インスタンス 関数
ホスト 文字列 エミュレータ ホスト（例: localhost）
ポート 数値 エミュレータのポート（例: 5001）

戻り値:

void

httpsCallable(functionsInstance, name, options)

指定された名前の呼び出し可能な HTTPS トリガーへの参照を返します。

署名:

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

パラメータ

パラメータ 型 説明
関数インスタンス 関数
name 文字列 トリガーの名前。
オプション HttpsCallableOptions

戻り値:

HttpsCallable<RequestData、ResponseData>

httpsCallableFromURL(functionsInstance, url, options)

指定された URL の呼び出し可能な HTTPS トリガーへの参照を返します。

署名:

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

パラメータ

パラメータ 型 説明
関数インスタンス 関数
URL 文字列 トリガーの URL。
オプション HttpsCallableOptions

戻り値:

HttpsCallable<RequestData、ResponseData>

FunctionsErrorCode

Firebase Functions のステータス コードのセット。コードは、gRPC によって公開されているコードと同じです: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

可能な値: - 'cancelled': オペレーションはキャンセルされました（通常は呼び出し元によって）。- 'unknown': 不明なエラーまたは別のエラードメインからのエラーです。- 'invalid-argument': クライアントが無効な引数を指定しました。これは「failed-precondition」とは異なることに注意してください。「無効な引数」は、システムの状態に関係なく問題がある引数を示します（無効なフィールド名など）。- 'deadline-exceeded': 操作が完了する前に期限が切れました。システムの状態を変更するオペレーションの場合、オペレーションが正常に終了しても、このエラーが返されることがあります。たとえば、サーバーからの正常なレスポンスが、期限切れになるほど遅延していた可能性があります。- 'not-found': リクエストされたドキュメントは見つかりませんでした。- 'Already-exists': 作成しようとしたドキュメントがすでに存在します。- 'permission-denied': 呼び出し元には、指定された操作を実行する権限がありません。- 'resource-exhausted': 一部のリソースが不足しています。ユーザーごとの割り当て、またはファイル システム全体で容量が不足している可能性があります。- 'failed-precondition': システムがオペレーションの実行に必要な状態ではないため、オペレーションが拒否されました。- 'aborted': オペレーションは中止されました。通常は、トランザクションの中止などの同時実行の問題が原因です。- 'out-of-range': オペレーションが有効な範囲を超えて試行されました。- 'unImplemented': オペレーションが実装されていないか、サポートまたは有効化されていません。- 'internal': 内部エラーです。基になるシステムで予期される一部の不変条件が破損していることを意味します。これらのエラーのいずれかが表示される場合、何かが著しく壊れています。- 「unavailable」: サービスは現在利用できません。これは一時的な状態である可能性が高く、バックオフで再試行することで修正できます。- 'data-loss': 回復不能なデータの損失または破損。- 'unauthenticated': リクエストに、操作のための有効な認証情報がありません。

署名:

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

FunctionsErrorCodeCore

「functions/」の後に追加された関数のエラーコードの文字列です。コードの詳細については、FunctionsErrorCode をご覧ください。

署名:

export declare type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

HttpsCallable

"callable" への参照。Google Cloud Functions での HTTP トリガー。

署名:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;