Fonksiyonlar
İşlev | Tanım |
---|---|
onCall(seçenekler, işleyici) | İstemcilerin Firebase SDK kullanarak çağırabileceği çağrılabilir bir yöntem bildirir. |
onCall(işleyici) | İstemcilerin Firebase SDK kullanarak çağırabileceği çağrılabilir bir yöntem bildirir. |
onRequest(seçenekler, işleyici) | HTTPS isteklerini yönetir. |
onRequest(işleyici) | HTTPS isteklerini yönetir. |
Sınıflar
Sınıf | Tanım |
---|---|
HttpsError | İşlevi çağıran istemciye bir hata göndermek için işleyiciden atılabilen açık bir hata. |
Arayüzler
Arayüz | Tanım |
---|---|
ÇağrılabilirFonksiyon | İstemcilerin Firebase SDK kullanarak çağırabileceği çağrılabilir bir yöntem oluşturur. |
ÇağrılabilirSeçenekler | Çağrılabilir bir HTTPS işlevinde ayarlanabilecek seçenekler. |
Çağrılabilir İstek | Çağrılabilir bir işlevi çağırmak için kullanılan istek. |
HttpsSeçenekleri | onRequest HTTPS işlevinde ayarlanabilen seçenekler. |
Rica etmek | İstek gövdesinin tel formatı temsilini içeren açık bir istek. |
Takma Adları Yazın
Takma Ad yazın | Tanım |
---|---|
FonksiyonlarHataKodu | Firebase İşlevleri durum kodları kümesi. Kodlar gRPC tarafından sunulan kodlarla aynıdır . |
Httpsİşlevi | HTTPS isteklerini yönetir. |
https.onCall()
İstemcilerin Firebase SDK kullanarak çağırabileceği çağrılabilir bir yöntem bildirir.
İmza:
export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
tercihler | ÇağrılabilirSeçenekler | Bu işlevde ayarlanacak seçenekler. |
idareci | (talep: CallableRequest <T>) => Geri Dön | https.CallableRequest alan bir işlev . |
İadeler:
CallableFunction<T, Return>
Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.
https.onCall()
İstemcilerin Firebase SDK kullanarak çağırabileceği çağrılabilir bir yöntem bildirir.
İmza:
export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
idareci | (talep: CallableRequest <T>) => Geri Dön | https.CallableRequest alan bir işlev . |
İadeler:
CallableFunction<T, Return>
Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.
https.onRequest()
HTTPS isteklerini yönetir.
İmza:
export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
tercihler | HttpsSeçenekleri | Bu işlevde ayarlanacak seçenekler |
idareci | (talep: Talep , yanıt: express.Response) => void | Söz<void> | https.Request ve yanıt nesnesini alan, Express uygulamasıyla aynı imzayı alan bir işlev. |
İadeler:
Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.
https.onRequest()
HTTPS isteklerini yönetir.
İmza:
export declare function onRequest(handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
idareci | (talep: Talep , yanıt: express.Response) => void | Söz<void> | https.Request ve yanıt nesnesini alan, Express uygulamasıyla aynı imzayı alan bir işlev. |
İadeler:
Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.
https.FunctionsErrorCode
Firebase İşlevleri durum kodları kümesi. Kodlar gRPC tarafından sunulan kodlarla aynıdır .
Olası değerler:
cancelled
: İşlem iptal edildi (genellikle arayan tarafından).unknown
: Bilinmeyen hata veya farklı bir hata etki alanından gelen hata.invalid-argument
: İstemci geçersiz bir bağımsız değişken belirtti. Bununfailed-precondition
farklı olduğunu unutmayın. .invalid-argument
sistemin durumuna bakılmaksızın sorunlu olan argümanları belirtir (örn. geçersiz bir alan adı).deadline-exceeded
: İşlem tamamlanamadan son tarih doldu. Sistemin durumunu değiştiren işlemlerde, işlem başarıyla tamamlansa bile bu hata dönebilir. Örneğin, bir sunucudan gelen başarılı bir yanıt, sürenin dolmasına yetecek kadar gecikmiş olabilir.not-found
: İstenilen bazı belgeler bulunamadı.already-exists
: Oluşturmaya çalıştığımız bazı belgeler zaten mevcut.permission-denied
: Arayanın belirtilen işlemi yürütme izni yok.resource-exhausted
: Kaynakların bir kısmı tükendi, kullanıcı başına kota olabilir veya dosya sisteminin tamamında yer kalmadı.failed-precondition
: Sistem, işlemin yürütülmesi için gerekli durumda olmadığından işlem reddedildi.aborted
: İşlem, genellikle işlem iptalleri vb. gibi eşzamanlılık sorunu nedeniyle iptal edildi.out-of-range
: Geçerli aralığın ötesinde işlem yapılmaya çalışıldı.unimplemented
: İşlem uygulanmıyor veya desteklenmiyor/etkinleştirilmiyor.internal
: Dahili hatalar. Temel sistemin beklediği bazı değişmezlerin bozulduğu anlamına gelir. Bu hatalardan birini görüyorsanız bir şeyler çok bozuk demektir.unavailable
: Hizmet şu anda kullanılamıyor. Bu büyük olasılıkla geçici bir durumdur ve geri çekilmeyle yeniden denenerek düzeltilebilir.data-loss
: Kurtarılamaz veri kaybı veya bozulması.unauthenticated
: İstek, işlem için geçerli kimlik doğrulama bilgilerine sahip değil.
İmza:
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 isteklerini yönetir.
İmza:
export type HttpsFunction = ((
req: Request,
res: express.Response) => void | Promise<void>) & {
__trigger?: unknown;
__endpoint: ManifestEndpoint;
};