https namespace

İşlevler

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

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
CallableFunction Müşterilerin Firebase SDK'sı kullanarak çağırması için çağrılabilir bir yöntem oluşturur.
CallableOptions Çağrılabilir bir HTTPS işlevinde ayarlanabilecek seçenekler.
Aranabilirİstek Çağrılabilir bir işlevi çağırmak için kullanılan istek.
HttpsOptions onRequest HTTPS işlevinde ayarlanabilecek seçenekler.
İ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.
HttpsFunction HTTPS isteklerini işler.

https.onCall()

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

İmza:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parametreler

Parametre Tür Açıklama
opt. CallableOptions Bu işlevde ayarlanacak seçenekler.
handler (istek: CallableRequest<T>) => Dönüş https.CallableRequest alan bir işlev.

Şunu döndürür:

CallableFunction<T, Return>

Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.

https.onCall()

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

İmza:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parametreler

Parametre Tür Açıklama
handler (istek: CallableRequest<T>) => Dönüş https.CallableRequest alan bir işlev.

Şunu döndürür:

CallableFunction<T, Return>

Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.

https.onRequest()

HTTPS isteklerini işler.

İmza:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

Parametreler

Parametre Tür Açıklama
opt. HttpsOptions Bu işlevde belirlenecek seçenekler
handler (istek: İstek, yanıt: express.Response) => geçersiz | Taahhüt<void> Express uygulamalarıyla aynı imzaya sahip olan https.Request ve yanıt nesnesini alan bir işlev.

Şunu döndürür:

HttpsFunction

Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.

https.onRequest()

HTTPS isteklerini işler.

İmza:

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

Parametreler

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

Şunu döndürür:

HttpsFunction

Dışa aktarabileceğiniz ve dağıtabileceğiniz bir işlev.

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";

https.HttpsFunction

HTTPS isteklerini işler.

İmza:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};