Functions
| Fungsi | Deskripsi |
|---|---|
| onCall(handler) | Mendeklarasikan metode callable untuk klien yang akan dipanggil menggunakan Firebase SDK. |
| onRequest(pengendali) | Menangani permintaan HTTP. |
Kelas
| Class | Deskripsi |
|---|---|
| HttpsError | Error eksplisit yang dapat ditampilkan dari pengendali untuk mengirim error ke klien yang memanggil fungsi. |
Antarmuka
| Antarmuka | Deskripsi |
|---|---|
| CallableContext | Antarmuka untuk metadata untuk API seperti yang diteruskan ke pengendali. |
| Permintaan | Permintaan ekspres dengan representasi format kabel dari isi permintaan. |
Ketik Alias
| Ketik Alias | Deskripsi |
|---|---|
| FunctionsErrorCode | Kumpulan kode status Firebase Functions. Kode tersebut sama dengan kode yang ditampilkan oleh gRPC. |
https.onCall()
Mendeklarasikan metode callable untuk klien yang akan dipanggil menggunakan Firebase SDK.
Tanda Tangan:
export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| handler | (data: apa pun, konteks: CallableContext) => semua | Janjikan<any> | Metode yang mengambil data dan konteks serta menampilkan nilai. |
Hasil:
HttpsFunction & 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 | Deskripsi |
|---|---|---|
| handler | (req: Request, resp: express.Response) => tidak berlaku | Janji<void> | Fungsi yang menggunakan objek permintaan dan respons, tanda tangan yang sama seperti aplikasi Express. |
Hasil:
https.FunctionsErrorCode
Kumpulan kode status Firebase Functions. Kode tersebut sama dengan kode yang ditampilkan oleh gRPC.
Nilai yang mungkin:
cancelled: Operasi dibatalkan (biasanya oleh pemanggil).unknown: Error tidak diketahui atau error dari domain error yang berbeda.invalid-argument: Klien menentukan argumen yang tidak valid. Perhatikan bahwa ini berbeda denganfailed-precondition.invalid-argumentmenunjukkan argumen yang bermasalah, apa pun status sistemnya (misalnya, nama kolom yang tidak valid).deadline-exceeded: Batas waktu berakhir sebelum operasi selesai. Untuk operasi yang mengubah keadaan sistem, error ini mungkin ditampilkan, bahkan jika, operasi tersebut telah selesai. Sebagai contoh, respons berhasil dari suatu server dapat tertunda selama waktu yang cukup lama hingga tenggat waktu berakhir.not-found: Beberapa dokumen yang diminta tidak ditemukan.already-exists: Beberapa dokumen yang kami coba buat sudah ada.permission-denied: Pemanggil tidak memiliki izin untuk menjalankan operasi yang ditentukan.resource-exhausted: Beberapa resource telah habis, mungkin kuota per pengguna, atau mungkin kapasitas keseluruhan sistem file sudah habis.failed-precondition: Operasi ditolak karena sistem tidak dalam status yang dibutuhkan untuk menjalankan operasi.aborted: Operasi dibatalkan, biasanya karena masalah serentak seperti pembatalan transaksi, dll.out-of-range: Operasi diupayakan melewati rentang yang valid.unimplemented: Operasi tidak diterapkan atau tidak didukung/diaktifkan.internal: Error internal. Artinya, beberapa invarian yang diharapkan oleh sistem yang mendasarinya telah rusak. Jika Anda melihat error ini, artinya ada sesuatu yang sangat rusak.unavailable: Layanan saat ini tidak tersedia. Kemungkinan besar ini adalah kondisi sementara dan dapat diperbaiki dengan mencoba kembali dengan backoff.data-loss: Kehilangan atau kerusakan data yang tidak dapat dipulihkan.unauthenticated: Permintaan tidak memiliki kredensial autentikasi yang valid untuk operasi.
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";