functions package

Cloud Functions for Firebase

Functions

Fungsi Deskripsi
fungsi(aplikasi, ...)
getFunctions(aplikasi, regionOrCustomDomain) Menampilkan instance Functions untuk aplikasi tertentu.
function(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, host, port) Ubah instance ini untuk berkomunikasi dengan emulator Cloud Functions.Catatan: ini harus dipanggil sebelum instance ini digunakan untuk melakukan operasi apa pun.
httpsCallable(functionsInstance, name, options) Menampilkan referensi ke pemicu HTTPS callable dengan nama tertentu.
httpsCallableFromURL(functionsInstance, url, options) Menampilkan referensi ke pemicu HTTPS callable dengan URL yang ditentukan.

Antarmuka

Antarmuka Deskripsi
Fungsi Instance Functions.
FunctionsError Error yang ditampilkan oleh SDK klien Firebase Functions.
HttpsCallableOptions Antarmuka untuk metadata tentang cara panggilan harus dijalankan.
HttpsCallableResult HttpsCallableResult menggabungkan satu hasil dari panggilan fungsi.

Ketik Alias

Ketik Alias Deskripsi
FunctionsErrorCode Kumpulan kode status Firebase Functions. Kode tersebut sama dengan kode yang ditampilkan oleh gRPC di sini: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdNilai yang mungkin: - 'cancelled': Operasi dibatalkan (biasanya oleh pemanggil). - 'tidak diketahui': Error tidak diketahui atau error dari domain error yang berbeda. - 'invalid-argument': Klien menentukan argumen yang tidak valid. Perhatikan bahwa ini berbeda dengan 'failed-precondition'. 'argumen-tidak valid' menunjukkan argumen yang bermasalah, apa pun status sistemnya (mis. nama kolom yang tidak valid). - 'batas waktu terlampaui': 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. - 'sudah ada': Beberapa dokumen yang kami coba buat sudah ada. - 'permission-denied': Pemanggil tidak memiliki izin untuk menjalankan operasi yang ditentukan. - 'resource habis': Beberapa resource telah habis, mungkin kuota per pengguna, atau mungkin kapasitas seluruh sistem file sudah habis. - 'failed-precondition': Operasi ditolak karena sistem tidak dalam status yang diperlukan untuk eksekusi operasi. - 'dibatalkan': Operasi dibatalkan, biasanya karena masalah konkurensi seperti pembatalan transaksi, dll. - 'out-of-range': Operasi dicoba melewati rentang yang valid. - 'unimplementation': 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. - 'kehilangan data': Data hilang atau rusak yang tidak dapat dipulihkan. - 'unauthenticated': Permintaan tidak memiliki kredensial autentikasi yang valid untuk operasi.
FunctionsErrorCodeCore String kode error fungsi ditambahkan setelah "functions/" awalan produk. Lihat FunctionsErrorCode untuk mengetahui dokumentasi kode selengkapnya.
HttpsCallable Referensi ke "callable" Pemicu HTTP di Google Cloud Functions.

function(aplikasi, ...)

getFunctions(aplikasi, regionOrCustomDomain)

Menampilkan instance Functions untuk aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
aplikasi AplikasiFirebase FirebaseApp yang akan digunakan.
regionOrCustomDomain string salah satu dari: a) Region tempat fungsi callable berada (mis: us-central1) b) Domain kustom yang menghosting fungsi callable (mis.: https://mydomain.com)

Hasil:

Fungsi

function(functionsInstance, ...)

connectFunctionsEmulator(functionsInstance, host, port)

Ubah instance ini untuk berkomunikasi dengan emulator Cloud Functions.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
functionInstance Fungsi
host string Host emulator (misalnya: localhost)
port angka Port emulator (mis.: 5001)

Hasil:

void

httpsCallable(functionsInstance, name, options)

Menampilkan referensi ke pemicu HTTPS callable dengan nama tertentu.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
functionInstance Fungsi
name string Nama pemicu.
opsi HttpsCallableOptions

Hasil:

HttpsCallable<RequestData, ResponseData>

httpsCallableFromURL(functionsInstance, url, options)

Menampilkan referensi ke pemicu HTTPS callable dengan URL yang ditentukan.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
functionInstance Fungsi
url string URL pemicu.
opsi HttpsCallableOptions

Hasil:

HttpsCallable<RequestData, ResponseData>

FunctionsErrorCode

Kumpulan kode status Firebase Functions. Kode tersebut sama dengan kode yang diekspos oleh gRPC di sini: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Nilai yang mungkin: - 'cancelled': Operasi dibatalkan (biasanya oleh pemanggil). - 'tidak diketahui': Error tidak diketahui atau error dari domain error yang berbeda. - 'invalid-argument': Klien menentukan argumen yang tidak valid. Perhatikan bahwa ini berbeda dengan 'failed-precondition'. 'argumen-tidak valid' menunjukkan argumen yang bermasalah, apa pun status sistemnya (mis. nama kolom yang tidak valid). - 'batas waktu terlampaui': 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. - 'sudah ada': Beberapa dokumen yang kami coba buat sudah ada. - 'permission-denied': Pemanggil tidak memiliki izin untuk menjalankan operasi yang ditentukan. - 'resource habis': Beberapa resource telah habis, mungkin kuota per pengguna, atau mungkin kapasitas seluruh sistem file sudah habis. - 'failed-precondition': Operasi ditolak karena sistem tidak dalam status yang diperlukan untuk eksekusi operasi. - 'dibatalkan': Operasi dibatalkan, biasanya karena masalah konkurensi seperti pembatalan transaksi, dll. - 'out-of-range': Operasi dicoba melewati rentang yang valid. - 'unimplementation': 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. - 'kehilangan data': Data hilang atau rusak yang tidak dapat dipulihkan. - 'unauthenticated': Permintaan tidak memiliki kredensial autentikasi yang valid untuk operasi.

Tanda Tangan:

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

FunctionsErrorCodeCore

String kode error fungsi ditambahkan setelah "functions/" awalan produk. Lihat FunctionsErrorCode untuk mengetahui dokumentasi kode selengkapnya.

Tanda Tangan:

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

Referensi ke "callable" Pemicu HTTP di Google Cloud Functions.

Tanda Tangan:

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