firebase-functions package

Cloud Functions for Firebase için 2. nesil API. Bu SDK, derin içe aktarmaları destekler. Örneğin, pubsub ad alanı firebase-functions/v2 adresinde kullanılabilir veya doğrudan firebase-functions/v2/pubsub kaynağından içe aktarılabilir.

İşlevler

İşlev	Açıklama
setGlobalOptions(options)	2. nesil SDK kullanılarak yazılan tüm işlevler için varsayılan seçenekleri ayarlar.

Sınıflar

Sınıf	Açıklama
Değiştir	Realtime Database veya Cloud Firestore onWrite ve onUpdate etkinlikleri gibi durumu değişen etkinliklerin Cloud Functions arayüzü.Change nesnelerini oluşturmak için kullanılan biçim hakkında daha fazla bilgi için aşağıya bakın.

Arayüzler

Arayüz	Açıklama
Bulut Etkinliği	(BETA) CloudEventBase, sunucusuz bir etkinliği kodlamak için platformlar arası bir biçimin temelini oluşturur. Daha fazla bilgi için https://github.com/cloudevents/spec adresini ziyaret edin.
CloudFunction	(BETA) CloudEvents için bir işleyici.
EventHandlerOptions	Herhangi bir etkinlik işleme işlevinde ayarlanabilen ek alanlar.
GlobalOptions	GlobalOptions, projenin tamamında ayarlanabilen seçeneklerdir. Bu seçenekler, HTTPS ve olay işleme işlevlerinde yaygındır.

Ad alanları

Ad alanı	Açıklama
uyarılar
veritabanı
eventarc
firestore
https
kimlik
logger
params
pubsub
remoteConfig
planlayıcı
depolama alanı
görevler
testLab

Tür Takma Adları

Takma Ad yazın	Açıklama
IngressSetting	IngressSettings için kullanılabilen seçeneklerin listesi.
MemoryOption	Cloud Functions tarafından desteklenen kullanılabilir bellek seçeneklerinin listesi.
Parametreler	Tüm parametre yakalama gropu'larını bir kaydın anahtarlarıyla eşleyen bir tür. Örneğin, ParamsOf<"users/{uid}"> şudur: { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string } ParamsOf<"bir/statik/veriler"> şudur: {}esneklik nedeniyle ParamsOf , Kayıt<dize, dize>
DesteklenenBölge	Cloud Functions tarafından desteklenen tüm bölgelerin listesi (2. nesil).
VpcEgressSetting	VpcConnectorEgressSettings için kullanılabilen 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	Tür	Açıklama
seçenekler	GlobalOptions	Varsayılan olarak ayarlama seçenekleri

Şunu döndürür:

geçersiz

Giriş Ayarı

IngressSettings için kullanılabilir 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";

Parametreleri

Tüm parametre yakalama gropu'larını bir kaydın anahtarlarıyla eşleyen bir tür. Örneğin, ParamsOf<"users/{uid}"> şudur: { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string } ParamsOf<"bir/statik/veriler"> {}

Esneklik nedeniyle ParamsOf , Kayıt<dize, dize> olarak ayarlanmıştır.

İ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 tarafından desteklenen tüm bölgelerin listesi (2. nesil).

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

VpcEgressAyarı

VpcConnectorEgressSettings için kullanılabilir seçeneklerin listesi.

İmza:

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";