https namespace

機能

クラス

インターフェース

タイプエイリアス

https.onCall()

Firebase SDK を使用してクライアントが呼び出すための呼び出し可能メソッドを宣言します。

サイン：

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

パラメーター

戻り値：

CallableFunction<T, Return>

エクスポートしてデプロイできる機能。

https.onCall()

Firebase SDK を使用してクライアントが呼び出すための呼び出し可能メソッドを宣言します。

サイン：

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

パラメーター

戻り値：

CallableFunction<T, Return>

エクスポートしてデプロイできる機能。

https.onRequest()

HTTPS リクエストを処理します。

サイン：

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

パラメーター

戻り値：

Https関数

エクスポートしてデプロイできる機能。

https.onRequest()

HTTPS リクエストを処理します。

サイン：

export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

パラメーター

戻り値：

Https関数

エクスポートしてデプロイできる機能。

https.FunctionsErrorCode

Firebase Functions ステータス コードのセット。コードはgRPCで公開されているものと同じです。

可能な値:

• cancelled : 操作は (通常は呼び出し元によって) キャンセルされました。

• unknown : 不明なエラー、または別のエラー ドメインからのエラー。

• invalid-argument : クライアントが無効な引数を指定しました。これはfailed-preconditionとは異なることに注意してください。 invalid-argumentシステムの状態に関係なく問題のある引数 (無効なフィールド名など) を示します。

• deadline-exceeded : 操作が完了する前に期限が切れました。システムの状態を変更する操作の場合、操作が正常に完了した場合でも、このエラーが返されることがあります。たとえば、サーバーからの正常な応答が期限切れになるまで遅延する可能性があります。

• not-found : 要求されたドキュメントが見つかりませんでした。

• already-exists : 作成しようとしたドキュメントがすでに存在します。

• permission-denied : 呼び出し元には、指定された操作を実行する権限がありません。

• resource-exhausted : 一部のリソースが使い果たされています。おそらくユーザーごとのクォータか、ファイル システム全体のスペースが不足している可能性があります。

• failed-precondition : システムが操作の実行に必要な状態にないため、操作は拒否されました。

• aborted : 操作は中止されました。通常、トランザクションの中止などの同時実行の問題が原因です。

• out-of-range : 有効範囲を超えて操作が試みられました。

• unimplemented : 操作が実装されていないか、サポート/有効化されていません。

• internal : 内部エラー。基礎となるシステムによって予期されるいくつかの不変条件が壊れていることを意味します。これらのエラーのいずれかが表示された場合は、何かが非常に壊れています。

• unavailable ：現在サービスをご利用いただけません。これは一時的な状態である可能性が高く、バックオフを使用して再試行することで修正できる可能性があります。

• data-loss : 回復不可能なデータ損失または破損。

• unauthenticated : リクエストには、操作に対する有効な認証資格情報がありません。

サイン：

export type FunctionsErrorCode = "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";

https.HttpsFunction

HTTPS リクエストを処理します。

サイン：

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};