functions package

Fungsi Cloud untuk Firebase

Fungsi

Antarmuka

Ketik Alias

fungsi(aplikasi, ...)

getFunctions(aplikasi, wilayahAtauCustomDomain)

Mengembalikan instance Functions untuk aplikasi tertentu.

Tanda tangan:

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

Parameter

Pengembalian:

Fungsi

fungsi(fungsiInstance, ...)

connectFunctionsEmulator(fungsiInstance, 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

Pengembalian:

ruang kosong

httpsCallable(functionsInstance, nama, opsi)

Mengembalikan referensi ke pemicu HTTPS yang dapat dipanggil dengan nama tertentu.

Tanda tangan:

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

Parameter

Pengembalian:

HttpsDapat Dipanggil <Data Permintaan, Data Respons>

httpsCallableFromURL(functionsInstance, url, opsi)

Mengembalikan referensi ke pemicu HTTPS yang dapat dipanggil dengan url yang ditentukan.

Tanda tangan:

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

Parameter

Pengembalian:

HttpsDapat Dipanggil <Data Permintaan, Data Respons>

FungsiKode Kesalahan

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

Nilai yang mungkin: - 'dibatalkan': Operasi dibatalkan (biasanya oleh pemanggil). - 'tidak diketahui': Kesalahan tidak diketahui atau kesalahan dari domain kesalahan yang berbeda. - 'argumen tidak valid': Klien menentukan argumen yang tidak valid. Perhatikan bahwa ini berbeda dari 'prakondisi gagal'. 'argumen-tidak valid' menunjukkan argumen yang bermasalah terlepas dari keadaan sistem (misalnya nama field tidak valid). - 'batas waktu terlampaui': Batas waktu berakhir 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. - 'tidak ditemukan': Beberapa dokumen yang diminta tidak ditemukan. - 'sudah ada': Beberapa dokumen yang kami coba buat sudah ada. - 'izin ditolak': Penelepon tidak memiliki izin untuk menjalankan operasi yang ditentukan. - 'kehabisan sumber daya': Beberapa sumber daya telah habis, mungkin kuota per pengguna, atau mungkin seluruh sistem file kehabisan ruang. - 'prakondisi gagal': Operasi ditolak karena sistem tidak dalam kondisi yang diperlukan untuk pelaksanaan operasi. - 'dibatalkan': Operasi dibatalkan, biasanya karena masalah konkurensi seperti pembatalan transaksi, dll. - 'di luar jangkauan': Operasi dilakukan melewati rentang yang valid. - 'tidak diterapkan': 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. - 'tidak tersedia': Layanan saat ini tidak tersedia. Kemungkinan besar ini adalah kondisi sementara dan dapat diperbaiki dengan mencoba lagi dengan backoff. - 'kehilangan data': Kehilangan atau kerusakan data yang tidak dapat dipulihkan. - 'tidak diautentikasi': Permintaan tidak memiliki kredensial otentikasi yang valid untuk operasi tersebut.

Tanda tangan:

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

FungsiErrorCodeCore

String kode kesalahan fungsi ditambahkan setelah awalan produk "fungsi/". Lihat FunctionsErrorCode untuk 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';

HttpsDapat Dipanggil

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

Tanda tangan:

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