firebase-functions package

Fonksiyonlar

İşlev Tanım
yapılandırma() Üçüncü taraf API anahtarları veya diğer ayarlar gibi proje yapılandırma verilerini saklayın ve alın. Yapılandırma değerlerini, [Ortam Yapılandırması](/docs/functions/config-env) bölümünde açıklandığı gibi Firebase CLI'yi kullanarak ayarlayabilirsiniz.
optionsToEndpoint(seçenekler)
optionsToTrigger(seçenekler)
bölge(bölgeler) İşlevin dağıtıldığı bölgeleri yapılandırın.
runWith(runtimeOptions) İşlev için çalışma zamanı seçeneklerini yapılandırın.

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.
Fonksiyon Oluşturucu

Arayüzler

Arayüz Tanım
Engelleme Fonksiyonu Kimlik Doğrulama Engelleme tetikleyicilerine yönelik işlev türü.
BulutFunction HTTPS olmayan tüm tetikleyiciler için işlev türü. Bir Bulut İşlevi tanımlamak için bunun JavaScript dosyanızdan dışa aktarılması gerekir. Bu tür, şablonlu bir Event nesnesini tek argüman olarak alan özel bir JavaScript işlevidir.
DağıtımSeçenekleri İşlev dağıtımı sırasında geçerli olan bir işleve ilişkin yapılandırma seçenekleri.
Etkinlik Bir etkinlik için tel formatı.
Etkinlik Bağlamı Bir olayın gerçekleştiği bağlam.
Arıza Politikası Arka plan işlevlerinde arıza ilkesi için yapılandırma seçeneği.
Httpsİşlevi HTTPS tetikleyicileri için işlev türü. Bir Bulut İşlevi tanımlamak için bunun JavaScript dosyanızdan dışa aktarılması gerekir.
Kaynak Kaynak, bir kaynağı tanımlamak için kullanılan standart bir biçimdir (google.rpc.context.AttributeContext.Resource). Cloud Functions'ta depolama paketi gibi işlevi tetikleyen kaynaktır.
Çalıştırılabilir Bir Runnable, kullanıcı tanımlı işlevi doğrudan çağıran bir run yöntemine sahiptir; birim testi için kullanışlıdır.
Çalışma Zamanı Seçenekleri Çalışma zamanında geçerli olan bir işlev için yapılandırma seçenekleri.
Takvim Zamanlanmış işlevler için yapılandırma seçenekleri.
ZamanlamayıYenidenDeneYapılandırma Zamanlayıcı yeniden deneme seçenekleri. Yalnızca zamanlanmış işlevler için geçerlidir.

Ad alanları

Ad alanı Tanım
analitik
yetki
veri tabanı
itfaiye deposu
https
ağaç kesicisi
parametreler
yayınevi
RemoteConfig
depolamak
görevler
testLab

Değişkenler

Değişken Tanım
uygulama
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS IngressSettings için mevcut seçeneklerin listesi.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS Bulut İşlevleri maksimum zaman aşımı değeri.
MIN_TIMEOUT_SECONDS Cloud Functions minimum zaman aşımı değeri.
RESET_VALUE Yapılandırmayı platform varsayılanına sıfırlamak için özel yapılandırma değeri.
SUPPORTED_REGIONS Cloud Functions tarafından desteklenen tüm bölgelerin listesi.
VALID_MEMORY_OPTIONS Cloud Functions tarafından desteklenen kullanılabilir bellek seçeneklerinin listesi.
VPC_EGRESS_SETTINGS_OPTIONS VpcConnectorEgressSettings için mevcut seçeneklerin listesi.

yapılandırma()

Üçüncü taraf API anahtarları veya diğer ayarlar gibi proje yapılandırma verilerini saklayın ve alın. Yapılandırma değerlerini, [Ortam Yapılandırması](/docs/functions/config-env) bölümünde açıklandığı gibi Firebase CLI'yi kullanarak ayarlayabilirsiniz.

İmza:

export declare function config(): Record<string, any>;

İadeler:

Kayıt<string, any>

optionsToEndpoint()

İmza:

export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

Parametreler

Parametre Tip Tanım
seçenekler DağıtımSeçenekleri

İadeler:

ManifestEndpoint

optionsToTrigger()

İmza:

export declare function optionsToTrigger(options: DeploymentOptions): any;

Parametreler

Parametre Tip Tanım
seçenekler DağıtımSeçenekleri

İadeler:

herhangi

bölge()

İşlevin dağıtıldığı bölgeleri yapılandırın.

İmza:

export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Parametreler

Parametre Tip Tanım
bölgeler Dizi<(typeof SUPPORTED_REGIONS )[sayı] | dize | İfade <string> | Değeri Sıfırla> Daha fazla bölge dizesinden biri.

İadeler:

Fonksiyon Oluşturucu

örnek 1

işlevler.bölge('us-doğu1')

Örnek 2

işlevler.bölge('biz-doğu1', 'biz-merkez1')

runWith()

İşlev için çalışma zamanı seçeneklerini yapılandırın.

İmza:

export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parametreler

Parametre Tip Tanım
çalışma zamanıSeçenekleri Çalışma Zamanı Seçenekleri İsteğe bağlı alanlara sahip nesne: 1. memory : işleve ayrılacak bellek miktarı, olası değerler şunlardır: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' ve '8GB' . 2. timeoutSeconds : saniye cinsinden işlev için zaman aşımı, olası değerler 0 ile 540 arasıdır. 3. failurePolicy : işlevin başarısızlık politikası; boolean true değeri boş bir yeniden deneme nesnesi sağlamaya eşdeğerdir. 4. vpcConnector : aynı proje ve bölgedeki bir VPC konektörünün kimliği. 5. vpcConnectorEgressSettings : bir vpcConnector ayarlandığında, vpcConnector üzerinden hangi çıkış trafiğinin gönderildiğini kontrol edin. 6. serviceAccount : İşleve özel hizmet hesabı. 7. ingressSettings : HTTPS işlevinin nereden çağrılabileceğini kontrol eden işlev için giriş ayarları. Değer null olmamalıdır.

İadeler:

Fonksiyon Oluşturucu

uygulama

İmza:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

İmza:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

IngressSettings için mevcut seçeneklerin listesi.

İmza:

INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]

MAX_NUMBER_USER_LABELS

İmza:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Bulut İşlevleri maksimum zaman aşımı değeri.

İmza:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Cloud Functions minimum zaman aşımı değeri.

İmza:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

Yapılandırmayı platform varsayılanına sıfırlamak için özel yapılandırma değeri.

İmza:

RESET_VALUE: ResetValue

SUPPORTED_REGIONS

Cloud Functions tarafından desteklenen tüm bölgelerin listesi.

İmza:

SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]

VALID_MEMORY_OPTIONS

Cloud Functions tarafından desteklenen kullanılabilir bellek seçeneklerinin listesi.

İmza:

VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]

VPC_EGRESS_SETTINGS_OPTIONS

VpcConnectorEgressSettings için mevcut seçeneklerin listesi.

İmza:

VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]