functions package

Firebase için Bulut İşlevleri

Fonksiyonlar

İşlev Tanım
işlev(uygulama, ...)
getFunctions(app, bölgeOrCustomDomain) Verilen uygulama için bir Functions örneğini döndürür.
işlev(işlevlerÖrnek, ...)
connectFunctionsEmulator(functionsInstance, ana bilgisayar, 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 bunun çağrılması gerekir.
httpsCallable(functionsInstance, ad, seçenekler) Belirtilen adla çağrılabilir HTTPS tetikleyicisine bir başvuru döndürür.
httpsCallableFromURL(functionsInstance, url, seçenekler) Belirtilen URL ile çağrılabilir HTTPS tetikleyicisine bir başvuru döndürür.

Arayüzler

Arayüz Tanım
Fonksiyonlar Bir Functions örneği.
İşlevlerHata Firebase Functions istemci SDK'sının döndürdüğü bir hata.
HttpsCallableOptions Çağrıların nasıl yürütülmesi gerektiğine ilişkin meta veriler için bir arayüz.
HttpsCallableResult HttpsCallableResult , bir işlev çağrısından tek bir sonucu sarar.

Takma Adları Yazın

Takma Ad yazın Tanım
FonksiyonlarHataKodu Firebase İşlevleri durum kodları kümesi. Kodlar burada gRPC tarafından sunulan kodlarla aynıdır: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Olası değerler: - 'iptal edildi': İşlem iptal edildi (genellikle arayan tarafından). - 'bilinmiyor': Bilinmeyen hata veya farklı bir hata etki alanından gelen hata. - 'geçersiz argüman': Müşteri geçersiz bir argüman belirtti. Bunun 'başarısız önkoşul'dan farklı olduğunu unutmayın. 'geçersiz argüman', sistemin durumuna bakılmaksızın sorunlu olan argümanları belirtir (örn. geçersiz alan adı). - 'son tarih aşıldı': İşlem tamamlanamadan son tarih sona erdi. 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. - 'bulunamadı': İstenilen bazı belgeler bulunamadı. - 'zaten mevcut': Oluşturmaya çalıştığımız bazı belgeler zaten mevcut. - 'izin reddedildi': Arayanın belirtilen işlemi yürütme izni yok. - 'kaynak tükendi': Kaynakların bir kısmı tükendi, kullanıcı başına kota olabilir veya tüm dosya sisteminde yer kalmadı. - 'başarısız önkoşul': Sistem, işlemin yürütülmesi için gerekli durumda olmadığından işlem reddedildi. - 'durduruldu': İşlem, genellikle işlem iptalleri vb. gibi bir eşzamanlılık sorunu nedeniyle durduruldu. - 'aralık dışı': Geçerli aralığın ötesinde işlem yapılmaya çalışıldı. - 'uygulanmamış': İşlem uygulanmadı veya desteklenmiyor/etkinleştirilmiyor. - 'dahili': 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. - 'kullanılamıyor': Hizmet şu anda kullanılamıyor. Bu büyük olasılıkla geçici bir durumdur ve geri çekilmeyle yeniden denenerek düzeltilebilir. - 'veri kaybı': Kurtarılamaz veri kaybı veya bozulması. - 'kimliği doğrulanmamış': İsteğin, işlem için geçerli kimlik doğrulama bilgileri yok.
FonksiyonlarErrorCodeCore "İşlevler/" ürün önekinden sonra eklenen işlevler hata kodu dizesi. Kodların tam belgeleri için FunctionsErrorCode'a bakın.
HttpsCallable Google Cloud Functions'ta "çağrılabilir" bir HTTP tetikleyicisine referans.

işlev(uygulama, ...)

getFunctions(app, bölgeOrCustomDomain)

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

İmza:

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

Parametreler

Parametre Tip Tanım
uygulama Firebase Uygulaması Kullanılacak Firebase Uygulaması .
bölgeVeyaÖzelEtkiAlanı sicim aşağıdakilerden 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://mydomain.com)

İadeler:

Fonksiyonlar

işlev(işlevlerÖrnek, ...)

connectFunctionsEmulator(functionsInstance, ana bilgisayar, 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 Tip Tanım
işlevlerÖrnek Fonksiyonlar
ev sahibi sicim Emülatör ana bilgisayarı (ör. localhost)
liman sayı Emülatör bağlantı noktası (ör. 5001)

İadeler:

geçersiz

httpsCallable(functionsInstance, ad, seçenekler)

Belirtilen adla ç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 Tip Tanım
işlevlerÖrnek Fonksiyonlar
isim sicim Tetikleyicinin adı.
seçenekler HttpsCallableOptions

İadeler:

HttpsCallable <İstekVerileri, YanıtVerileri>

httpsCallableFromURL(functionsInstance, url, seçenekler)

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 Tip Tanım
işlevlerÖrnek Fonksiyonlar
URL sicim Tetikleyicinin URL'si.
seçenekler HttpsCallableOptions

İadeler:

HttpsCallable <İstekVerileri, YanıtVerileri>

FonksiyonlarHataKodu

Firebase İşlevleri durum kodları kümesi. Kodlar burada gRPC tarafından sunulan kodlarla aynıdır: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Olası değerler: - 'iptal edildi': İşlem iptal edildi (genellikle arayan tarafından). - 'bilinmiyor': Bilinmeyen hata veya farklı bir hata etki alanından gelen hata. - 'geçersiz argüman': Müşteri geçersiz bir argüman belirtti. Bunun 'başarısız önkoşul'dan farklı olduğunu unutmayın. 'geçersiz argüman', sistemin durumuna bakılmaksızın sorunlu olan argümanları belirtir (örn. geçersiz alan adı). - 'son tarih aşıldı': İşlem tamamlanamadan son tarih sona erdi. 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. - 'bulunamadı': İstenilen bazı belgeler bulunamadı. - 'zaten mevcut': Oluşturmaya çalıştığımız bazı belgeler zaten mevcut. - 'izin reddedildi': Arayanın belirtilen işlemi yürütme izni yok. - 'kaynak tükendi': Kaynakların bir kısmı tükendi, kullanıcı başına kota olabilir veya tüm dosya sisteminde yer kalmadı. - 'başarısız önkoşul': Sistem, işlemin yürütülmesi için gerekli durumda olmadığından işlem reddedildi. - 'durduruldu': İşlem, genellikle işlem iptalleri vb. gibi bir eşzamanlılık sorunu nedeniyle durduruldu. - 'aralık dışı': Geçerli aralığın ötesinde işlem yapılmaya çalışıldı. - 'uygulanmamış': İşlem uygulanmadı veya desteklenmiyor/etkinleştirilmiyor. - 'dahili': 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. - 'kullanılamıyor': Hizmet şu anda kullanılamıyor. Bu büyük olasılıkla geçici bir durumdur ve geri çekilmeyle yeniden denenerek düzeltilebilir. - 'veri kaybı': Kurtarılamaz veri kaybı veya bozulması. - 'kimliği doğrulanmamış': İsteğin, işlem için geçerli kimlik doğrulama bilgileri yok.

İmza:

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

FonksiyonlarErrorCodeCore

"İşlevler/" ürün önekinden sonra eklenen işlevler hata kodu dizesi. Kodların tam belgeleri için FunctionsErrorCode'a 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

Google Cloud Functions'ta "çağrılabilir" bir HTTP tetikleyicisine referans.

İmza:

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