https namespace

Fungsi

Fungsi Keterangan
onCall (penangan) Mendeklarasikan metode panggilan bagi klien untuk memanggil menggunakan Firebase SDK.
berdasarkan Permintaan (penangan) Menangani permintaan HTTP.

Kelas

Kelas Keterangan
HttpsError Kesalahan eksplisit yang dapat dilempar dari penangan untuk mengirim kesalahan ke klien yang memanggil fungsi tersebut.

Antarmuka

Antarmuka Keterangan
Konteks yang Dapat Dipanggil Antarmuka metadata untuk API yang diteruskan ke pengendali.
Meminta Permintaan ekspres dengan representasi format kawat dari badan permintaan.

Ketik Alias

Ketik Alias Keterangan
FungsiKode Kesalahan Kumpulan kode status Firebase Functions. Kode-kodenya sama dengan yang diekspos oleh gRPC .

https.onCall()

Mendeklarasikan metode panggilan bagi klien untuk memanggil menggunakan Firebase SDK.

Tanda tangan:

export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

Parameter

Parameter Jenis Keterangan
penangan (data: apa saja, konteks: CallableContext ) => apa saja | Janji<apa saja> Sebuah metode yang mengambil data dan konteks dan mengembalikan nilai.

Pengembalian:

Fungsi Https & Dapat Dijalankan <apa saja>

https.onRequest()

Menangani permintaan HTTP.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
penangan (req: Permintaan, resp: express.Response) => void | Janji<batal> Fungsi yang mengambil objek permintaan dan respons, tanda tangan yang sama dengan aplikasi Express.

Pengembalian:

Fungsi Https

https.FunctionsErrorCode

Kumpulan kode status Firebase Functions. Kode-kodenya sama dengan yang diekspos oleh gRPC .

Nilai yang mungkin:

  • cancelled : Operasi dibatalkan (biasanya oleh penelepon).

  • unknown : Kesalahan tidak diketahui atau kesalahan dari domain kesalahan yang berbeda.

  • invalid-argument : Klien memberikan argumen yang tidak valid. Perhatikan bahwa ini berbeda dengan failed-precondition . invalid-argument menunjukkan argumen yang bermasalah terlepas dari keadaan sistem (misalnya nama bidang yang tidak valid).

  • deadline-exceeded : Batas waktu telah habis sebelum operasi dapat diselesaikan. Untuk operasi yang mengubah status sistem, kesalahan ini mungkin muncul meskipun operasi telah berhasil diselesaikan. Misalnya, respons yang berhasil dari server bisa saja tertunda cukup lama hingga tenggat waktunya habis.

  • not-found : Beberapa dokumen yang diminta tidak ditemukan.

  • already-exists : Beberapa dokumen yang kami coba buat sudah ada.

  • permission-denied : Penelepon tidak memiliki izin untuk menjalankan operasi yang ditentukan.

  • resource-exhausted : Beberapa sumber daya telah habis, mungkin kuota per pengguna, atau mungkin seluruh sistem file kehabisan ruang.

  • failed-precondition : Operasi ditolak karena sistem tidak dalam kondisi yang diperlukan untuk pelaksanaan operasi.

  • aborted : Operasi dibatalkan, biasanya karena masalah konkurensi seperti pembatalan transaksi, dll.

  • out-of-range : Operasi dicoba melewati rentang yang valid.

  • unimplemented : Operasi tidak diterapkan atau tidak didukung/diaktifkan.

  • internal : Kesalahan internal. Berarti beberapa invarian yang diharapkan oleh sistem yang mendasarinya telah rusak. Jika Anda melihat salah satu kesalahan ini, berarti ada sesuatu yang sangat rusak.

  • unavailable : Layanan saat ini tidak tersedia. Kemungkinan besar ini adalah kondisi sementara dan dapat diperbaiki dengan mencoba lagi dengan backoff.

  • data-loss : Kehilangan atau kerusakan data yang tidak dapat dipulihkan.

  • unauthenticated : Permintaan tidak memiliki kredensial autentikasi yang valid untuk operasi tersebut.

Tanda tangan:

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