functions package

Firebase のクラウド機能

機能

インターフェース

タイプエイリアス

関数(アプリ、...)

getFunctions(アプリ、地域またはカスタムドメイン)

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

サイン：

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

パラメーター

戻り値：

機能

関数(関数インスタンス, ...)

connectFunctionsEmulator(関数インスタンス、ホスト、ポート)

Cloud Functions エミュレーターと通信するようにこのインスタンスを変更します。

サイン：

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

パラメーター

戻り値：

空所

httpsCallable(関数インスタンス、名前、オプション)

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

サイン：

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

パラメーター

戻り値：

HttpsCallable <リクエストデータ、レスポンスデータ>

httpsCallableFromURL(関数インスタンス、URL、オプション)

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

サイン：

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

パラメーター

戻り値：

HttpsCallable <リクエストデータ、レスポンスデータ>

関数エラーコード

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

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

サイン：

export declare type FunctionsErrorCode = `functions/${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

Google Cloud Functions の「呼び出し可能な」HTTP トリガーへの参照。

サイン：

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