https namespace

İşlevler

İşlev Açıklama
onCall(işleyici) İstemcilerin Firebase SDK'sı kullanarak çağırması için çağrılabilir bir yöntem tanımlar.
onRequest(handler) HTTP isteklerini işleme.

Sınıflar

Sınıf Açıklama
Https Hatası İşlev çağıran istemciye bir hata göndermek için işleyiciden atılabilecek açık bir hata.

Arayüzler

Arayüz Açıklama
CallableContext İşleyiciye iletilen API meta verilerinin arayüzü.
İstek İstek gövdesinin kablo biçimi temsilini içeren açık istek.

Tür Takma Adları

Takma Ad yazın Açıklama
İşlevler Hata Kodu Firebase Functions durum kodları grubu. Kodlar, gRPC tarafından sunulan kodlarla aynıdır.

https.onCall()

İstemcilerin Firebase SDK'sı kullanarak çağırması için çağrılabilir bir yöntem tanımlar.

İmza:

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

Parametreler

Parametre Tür Açıklama
handler (veri: herhangi bir, bağlam: CallableContext) => herhangi biri | Söz veriyorum<herhangi biri> Veri ve bağlam alıp değer döndüren bir yöntem.

Şunu döndürür:

HttpsFunction ve Çalıştırılabilir<any>

https.onRequest()

HTTP isteklerini işleme.

İmza:

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

Parametreler

Parametre Tür Açıklama
handler (istek: İstek, resp: express.Response) => geçersiz | Taahhüt<void> Express uygulamalarıyla aynı imzası olan bir istek ve yanıt nesnesini alan işlev.

Şunu döndürür:

HttpsFunction

https.FunctionsErrorCode

Firebase Functions durum kodları grubu. 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 alanından gelen hata.

  • invalid-argument: İstemci, geçersiz bir bağımsız değişken belirtti. Bunun failed-precondition değerinden farklı olduğunu unutmayın. invalid-argument, sistemin durumundan bağımsız olarak sorunlu olan bağımsız değişkenleri belirtir (ör. geçersiz alan adı).

  • deadline-exceeded: İşlem tamamlanamadan son tarih doldu. Sistemin durumunu değiştiren işlemlerde, işlem başarıyla tamamlanmış olsa bile bu hata döndürülebilir. Örneğin, bir sunucudan gelen başarılı bir yanıt, son tarihin dolmasına yetecek kadar gecikmiş olabilir.

  • not-found: İstenen dokümanlardan bazıları bulunamadı.

  • already-exists: Oluşturmaya çalıştığımız bazı dokümanlar zaten mevcut.

  • permission-denied: Arayanın belirtilen işlemi yürütme izni yok.

  • resource-exhausted: Bazı kaynaklar tükendi (ör. kullanıcı başına kota). veya dosya sisteminde hiç alan kalmamış olabilir.

  • failed-precondition: Sistem, yürütülmesi için gereken durumda olmadığından işlem reddedildi.

  • aborted: İşlem, genellikle işlemin iptal edilmesi gibi eşzamanlılık sorunları nedeniyle iptal edilmiştir.

  • out-of-range: İşlem, geçerli aralığın dışında yapılmaya çalışıldı.

  • unimplemented: İşlem uygulanmadı veya desteklenmiyor/etkinleştirilmedi.

  • internal: Dahili hatalar. Temel sistem tarafından beklenen bazı sabit değerlerin bozulduğu anlamına gelir. Bu hatalardan birini görürseniz bir şeyler çok bozuk demektir.

  • unavailable: Hizmet şu anda kullanılamıyor. Bu durum büyük olasılıkla geçici bir durumdur ve geri alma işlemiyle tekrar deneyerek düzeltilebilir.

  • data-loss: Kurtarılamayan 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";