functions package

Cloud Functions for Firebase

İşlevler

İşlev Açıklama
fonksiyon(uygulama, ...)
getFunctions(uygulama, bölgeOrÖzelAlan) Belirli bir uygulama için Functions örneğini döndürür.
function(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, ana makine, bağlantı noktası) Cloud Functions emülatörüyle iletişim kurmak için bu örneği değiştirin.Not: Bu örnek, herhangi bir işlem yapmak için kullanılmadan önce çağrılmalıdır.
httpsCallable(functionsInstance, name, options) Belirtilen ada sahip çağrılabilir HTTPS tetikleyicisine bir başvuru döndürür.
httpsCallableFromURL(functionsInstance, url, options) Belirtilen URL ile çağrılabilir HTTPS tetikleyicisine bir başvuru döndürür.

Arayüzler

Arayüz Açıklama
İşlevler Functions örneği.
İşlev Hatası Firebase Functions istemci SDK'sı tarafından döndürülen bir hata.
HttpsCallableOptions Çağrıların nasıl yürütülmesi gerektiğine dair meta veriler için bir arayüz.
HttpsCallableResult HttpsCallableResult, işlev çağrısından gelen tek bir sonucu sarmalar.

Tür Takma Adları

Takma Ad yazın Açıklama
İşlevler Hata Kodu Firebase Functions durum kodları grubu. Kodlar, burada gRPC tarafından sunulan kodlarla aynıdır: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdOlası değerler: - 'cancelled': İşlem iptal edildi (genellikle çağrı yapan tarafından). - 'unknown': Bilinmeyen hata veya farklı bir hata alanından gelen hata. - 'geçersiz-bağımsız değişken': İstemci, geçersiz bir bağımsız değişken belirtti. Bunun "başarısız ön koşul"dan farklı olduğunu unutmayın. "geçersiz-bağımsız-argüman" sistemin durumundan bağımsız olarak sorunlu olan bağımsız değişkenleri belirtir (ör. geçersiz alan adı). - "deadline-exceeded" (son tarih-aşıldı): İşlem tamamlanamadan son tarih geçti. 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ı. - "zaten var": Oluşturmaya çalıştığımız bazı dokümanlar zaten mevcut. - "izin reddedildi": Arayanın belirtilen işlemi yürütme izni yok. - "Kaynak tükendi": Bazı kaynaklar tükendi (ör. kullanıcı başına belirlenen kota). veya dosya sisteminin tamamında alan kalmamış olabilir. - "failed-precondition" (başarısız-ön koşul): Sistem, işlemin yürütülmesi için gereken durumda olmadığından işlem reddedildi. - "iptal edildi": İşlem, genellikle işlemin iptalleri gibi eşzamanlılık sorunu nedeniyle iptal edildi. - "aralık dışında": İşlem, geçerli aralığın dışına çıkmaya çalışıldı. - 'uygulanmadı': İş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. - 'kullanılamıyor': 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. - "veri kaybı": Kurtarılamayan veri kaybı veya bozulması. - 'unauthenticated': İsteğin, işlemle ilgili geçerli kimlik doğrulama kimlik bilgileri yok.
FunctionsErrorCodeCore "Functions/" işlevinden sonra eklenen işlev hata kodu dizesi ürün önekini kullanın. Kodlarla ilgili tüm dokümanlar için FunctionsErrorCode sayfasına bakın.
HttpsCallable Bir "çağrılanabilir" referansı Google Cloud Functions'da HTTP tetikleyicisi.

function(uygulama; ...)

getFunctions(uygulama, bölgeVeÖzelAlan)

Belirli bir uygulama için Functions örneğini döndürür.

İmza:

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

Parametreler

Parametre Tür Açıklama
uygulama FirebaseUygulaması Kullanılacak FirebaseApp.
bölgeveyaÖzelAlan dize şunlardan biri: a) Çağrılabilir işlevlerin bulunduğu bölge (ör: us-central1) b) Çağrılabilir işlevleri barındıran özel bir alan adı (ör: https://alanim.com)

Şunu döndürür:

İşlevler

function(functionsInstance, ...)

ConnectFunctionsEmulator(functionsInstance, ana makine, bağlantı noktası)

Cloud Functions emülatörüyle iletişim kurmak için bu örneği değiştirin.

İmza:

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

Parametreler

Parametre Tür Açıklama
İşlevler Örneği İşlevler
düzenleyen dize Emülatör ana makinesi (ör. localhost)
bağlantı noktası sayı Emülatör bağlantı noktası (ör. 5001)

Şunu döndürür:

geçersiz

httpsCallable(functionsInstance, ad, seçenekler)

Belirtilen ada sahip çağrılabilir HTTPS tetikleyicisine bir başvuru döndürür.

İmza:

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

Parametreler

Parametre Tür Açıklama
İşlevler Örneği İşlevler
ad dize Tetikleyicinin adı.
seçenekler HttpsCallableOptions

Şunu döndürür:

HttpsCallable<RequestData, ResponseData>

httpsCallableFromURL(functionsInstance; url; options)

Belirtilen URL ile çağrılabilir HTTPS tetikleyicisine bir başvuru döndürür.

İmza:

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

Parametreler

Parametre Tür Açıklama
İşlevler Örneği İşlevler
url dize Tetikleyicinin URL'si.
seçenekler HttpsCallableOptions

Şunu döndürür:

HttpsCallable<RequestData, ResponseData>

İşlevler Hata Kodu

Firebase Functions durum kodları grubu. Kodlar, gRPC tarafından sunulan kodlarda aynıdır: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Olası değerler: - 'cancelled': İşlem iptal edildi (genellikle çağrı yapan tarafından). - 'unknown': Bilinmeyen hata veya farklı bir hata alanından gelen hata. - 'geçersiz-bağımsız değişken': İstemci, geçersiz bir bağımsız değişken belirtti. Bunun "başarısız ön koşul"dan farklı olduğunu unutmayın. "geçersiz-bağımsız-argüman" sistemin durumundan bağımsız olarak sorunlu olan bağımsız değişkenleri belirtir (ör. geçersiz alan adı). - "deadline-exceeded" (son tarih-aşıldı): İşlem tamamlanamadan son tarih geçti. 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ı. - "zaten var": Oluşturmaya çalıştığımız bazı dokümanlar zaten mevcut. - "izin reddedildi": Arayanın belirtilen işlemi yürütme izni yok. - "Kaynak tükendi": Bazı kaynaklar tükendi (ör. kullanıcı başına belirlenen kota). veya dosya sisteminin tamamında alan kalmamış olabilir. - "failed-precondition" (başarısız-ön koşul): Sistem, işlemin yürütülmesi için gereken durumda olmadığından işlem reddedildi. - "iptal edildi": İşlem, genellikle işlemin iptalleri gibi eşzamanlılık sorunu nedeniyle iptal edildi. - "aralık dışında": İşlem, geçerli aralığın dışına çıkmaya çalışıldı. - 'uygulanmadı': İş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. - 'kullanılamıyor': 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. - "veri kaybı": Kurtarılamayan veri kaybı veya bozulması. - 'unauthenticated': İsteğin, işlemle ilgili geçerli kimlik doğrulama kimlik bilgileri yok.

İmza:

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

FunctionsErrorCodeCore

"Functions/" işlevinden sonra eklenen işlev hata kodu dizesi ürün önekini kullanın. Kodlarla ilgili tüm dokümanlar için FunctionsErrorCode sayfasına bakın.

İmza:

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

Bir "çağrılanabilir" referansı Google Cloud Functions'da HTTP tetikleyicisi.

İmza:

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