Firebase için Bulut İşlevleri'ne yönelik 2. nesil API. Bu SDK derin içe aktarmaları destekler. Örneğin, pubsub
ad alanı firebase-functions/v2
mevcuttur veya doğrudan firebase-functions/v2/pubsub
içe aktarılabilir. .
Fonksiyonlar
İşlev | Tanım |
---|---|
setGlobalOptions(seçenekler) | 2. nesil SDK kullanılarak yazılan tüm işlevler için varsayılan seçenekleri ayarlar. |
Sınıflar
Sınıf | Tanım |
---|---|
Değiştirmek | Realtime Database veya Cloud Firestore onWrite ve onUpdate olayları gibi durumu değiştiren olaylar için Bulut İşlevleri arayüzü. Change nesnelerini oluşturmak için kullanılan format hakkında daha fazla bilgi için aşağıya bakın. |
Arayüzler
Arayüz | Tanım |
---|---|
Bulut Etkinliği | (BETA) CloudEventBase , sunucusuz bir olayı kodlamaya yönelik platformlar arası formatın temelidir. Daha fazla bilgi için bkz. https://github.com/cloudevents/spec. |
BulutFunction | (BETA) CloudEvents için bir işleyici. |
Olay İşleyici Seçenekleri | Herhangi bir olay işleme işlevinde ayarlanabilen ek alanlar. |
GlobalSeçenekler | GlobalOptions , projenin tamamında ayarlanabilecek seçeneklerdir. Bu seçenekler HTTPS ve olay işleme işlevlerinde ortaktır. |
Ad alanları
Ad alanı | Tanım |
---|---|
uyarılar | |
veri tabanı | |
olay arkı | |
itfaiye deposu | |
https | |
kimlik | |
ağaç kesicisi | |
parametreler | |
yayınevi | |
RemoteConfig | |
zamanlayıcı | |
depolamak | |
görevler | |
testLab |
Takma Adları Yazın
Takma Ad yazın | Tanım |
---|---|
Giriş Ayarı | IngressSettings için mevcut seçeneklerin listesi. |
Bellek Seçeneği | Cloud Functions tarafından desteklenen kullanılabilir bellek seçeneklerinin listesi. |
ParamsOf | Tüm parametre yakalama grubunu bir kaydın anahtarlarına eşleyen bir tür. Örneğin, ParamsOf < "kullanıcılar/ { kullanıcı kimliği } " > şu: { uid: string } ParamsOf < "kullanıcılar/ { kullanıcı kimliği } /kütükler/ { kayıt } " > şudur: { uid: string; günlük: string } ParamsOf < "bazı/statik/veri" > şu: { } Esneklik nedeniyle ParamsOf |
Desteklenen Bölge | Cloud Functions (2. nesil) tarafından desteklenen tüm bölgelerin listesi. |
VpcEgressAyarları | VpcConnectorEgressSettings için mevcut seçeneklerin listesi. |
setGlobalOptions()
2. nesil SDK kullanılarak yazılan tüm işlevler için varsayılan seçenekleri ayarlar.
İmza:
export declare function setGlobalOptions(options: GlobalOptions): void;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
seçenekler | GlobalSeçenekler | Varsayılan olarak ayarlama seçenekleri |
İadeler:
geçersiz
Giriş Ayarı
IngressSettings
için mevcut seçeneklerin listesi .
İmza:
export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";
Bellek Seçeneği
Cloud Functions tarafından desteklenen kullanılabilir bellek seçeneklerinin listesi.
İmza:
export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";
ParamsOf
Tüm parametre yakalama grubunu bir kaydın anahtarlarına eşleyen bir tür. Örneğin, ParamsOf < "kullanıcılar/ { kullanıcı kimliği } " > şu: { uid: string } ParamsOf < "kullanıcılar/ { kullanıcı kimliği } /kütükler/ { kayıt } " > şudur: { uid: string; günlük: string } ParamsOf < "bazı/statik/veri" > şu: { }
Esneklik nedeniyle ParamsOf
İmza:
export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
[Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};
Desteklenen Bölge
Cloud Functions (2. nesil) tarafından desteklenen tüm bölgelerin listesi.
İmza:
export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";
VpcEgressAyarları
VpcConnectorEgressSettings
için mevcut seçeneklerin listesi .
İmza:
export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";