firebase-functions package

Funkcje

Funkcja	Opis
config(),	Przechowywanie i pobieranie danych konfiguracyjnych projektu, takich jak klucze interfejsu API innych firm czy inne ustawienia. Wartości konfiguracyjne możesz ustawić za pomocą interfejsu wiersza poleceń Firebase zgodnie z opisem w sekcji [Konfiguracja środowiska](/docs/functions/config-env).
optionsToEndpoint(opcje)
optionsToTrigger(opcje)
region(regions)	Skonfiguruj regiony, w których funkcja jest wdrożona.
runWith(runtimeOptions),	Skonfiguruj opcje środowiska wykonawczego dla funkcji.

Zajęcia

Klasa	Opis
Zmień	Interfejs Cloud Functions dla zdarzeń, które zmieniają stan, takich jak Baza danych czasu rzeczywistego lub Cloud Firestore onWrite i onUpdate.Więcej informacji o formacie używanym do tworzenia obiektów Change znajdziesz poniżej.
Kreator funkcji

Interfejsy

Interfejs	Opis
BlockFunction	Typ funkcji dla aktywatorów blokowania uwierzytelniania.
Funkcja w Cloud Functions	Typ funkcji w przypadku wszystkich aktywatorów niezwiązanych z HTTPS. Wartość tę należy wyeksportować z pliku JavaScript, aby zdefiniować funkcję w Cloud Functions.Ten typ jest specjalną funkcją JavaScriptu, która jako jedynym argumentem wykorzystuje obiekt Event utworzony na podstawie szablonu.
DeploymentOptions (Opcje wdrażania)	Opcje konfiguracji funkcji, która ma zastosowanie podczas wdrażania funkcji.
Zdarzenie	Format drutowy dla zdarzenia.
EventContext	Kontekst, w którym wystąpiło zdarzenie.
FailurePolicy	Opcja konfiguracji zasad błędów związanych z funkcjami w tle.
HttpsFunction	Typ funkcji aktywatorów HTTPS. Należy go wyeksportować z pliku JavaScript, aby zdefiniować funkcję w Cloud Functions.
Zasób	Zasób to standardowy format definiowania zasobu (google.rpc.context.AttributeContext.Resource). W Cloud Functions jest to zasób, który aktywował funkcję, np. zasobnik na dane.
Możliwe do uruchomienia	Obiekt wykonywalny zawiera metodę run, która bezpośrednio wywołuje funkcję zdefiniowaną przez użytkownika, co jest przydatne przy testowaniu jednostkowym.
RuntimeOptions (Opcje środowiska wykonawczego)	Opcje konfiguracji funkcji stosowanej w czasie działania.
Zaplanuj	Opcje konfiguracji funkcji zaplanowanych.
SchedulePonówConfig	Opcje ponownych prób algorytmu szeregowania. Dotyczy tylko funkcji zaplanowanych.

Przestrzenie nazw

Przestrzeń nazw	Opis
statystyki
auth
baza danych
firestore
https
rejestrator
parametry
pubsub
remoteConfig
miejsce na dane
zadania
testLab

Zmienne

Zmienna	Opis
aplikacja
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS	Lista dostępnych opcji ustawień Ingress.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS	Maksymalna wartość limitu czasu w Cloud Functions.
MIN_TIMEOUT_SECONDS	Wartość minimalnego limitu czasu w Cloud Functions.
RESET_VALUE	Specjalna wartość konfiguracji do zresetowania konfiguracji do wartości domyślnej platformy.
OBSŁUGIWANE REGIONY	Lista wszystkich regionów obsługiwanych przez Cloud Functions.
PRAWIDŁOWE_OPCJE_PAMIĘCI	Lista dostępnych opcji pamięci obsługiwanych przez Cloud Functions.
VPC_EGRESS_SETTINGS_OPTIONS	Lista dostępnych opcji VpcConnectorEgressSettings.

config()

Przechowywanie i pobieranie danych konfiguracyjnych projektu, takich jak klucze interfejsu API innych firm czy inne ustawienia. Wartości konfiguracyjne możesz ustawić za pomocą interfejsu wiersza poleceń Firebase zgodnie z opisem w sekcji [Konfiguracja środowiska](/docs/functions/config-env).

Podpis:

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

Zwroty:

Rekord<ciąg, dowolny>

optionsToEndpoint()

Podpis:

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

Parametry

Parametr	Typ	Opis
opcje	DeploymentOptions (Opcje wdrażania)

Zwroty:

Punkt końcowy pliku manifestu

optionsToTrigger()

Podpis:

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

Parametry

Parametr	Typ	Opis
opcje	DeploymentOptions (Opcje wdrażania)

Zwroty:

dowolny

region()

Skonfiguruj regiony, w których funkcja jest wdrożona.

Podpis:

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

Parametry

Parametr	Typ	Opis
regiony	Tablica<(typeof SUPPORTED_REGIONS)[number] | ciąg znaków | Wyrażenie<ciąg> | ResetValue>	Jeden z kolejnych ciągów tekstowych dotyczących regionu.

Zwroty:

Kreator funkcji

Przykład 1

features.region('us-east1')

Przykład 2

features.region('us-east1', 'us-central1')

uruchomienieZ()

Skonfiguruj opcje środowiska wykonawczego dla funkcji.

Podpis:

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

Parametry

Parametr	Typ	Opis
Opcje środowiska wykonawczego	RuntimeOptions (Opcje środowiska wykonawczego)	Obiekt z polami opcjonalnymi: 1. memory: ilość pamięci, która ma zostać przydzielona do funkcji. Możliwe wartości to „128 MB”, „256 MB”, „512 MB”, „1 GB”, „2 GB”, „4 GB” i „8 GB”. 2. timeoutSeconds: czas oczekiwania funkcji w sekundach. Możliwe wartości to od 0 do 540. 3. failurePolicy: zasada niepowodzenia funkcji, przy czym wartość logiczna true oznacza podanie pustego obiektu ponowienia próby. 4. vpcConnector: identyfikator oprogramowania sprzęgającego VPC w tym samym projekcie i regionie. 5. vpcConnectorEgressSettings: gdy skonfigurowany jest vpcConnector, określ, jaki ruch wychodzący ma być przez niego skonfigurowany. 6. serviceAccount: konkretne konto usługi dla funkcji. 7. ingressSettings: ustawienia ruchu przychodzącego dla funkcji, które określają, skąd można wywołać funkcję HTTPS.Wartość nie może być pusta.

Zwroty:

Kreator funkcji

aplikacja

Podpis:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

Podpis:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS:

Lista dostępnych opcji ustawień Ingress.

Podpis:

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

MAX_NUMBER_USER_LABELS

Podpis:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Maksymalna wartość limitu czasu w Cloud Functions.

Podpis:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Wartość minimalnego limitu czasu w Cloud Functions.

Podpis:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

Specjalna wartość konfiguracji do zresetowania konfiguracji do wartości domyślnej platformy.

Podpis:

RESET_VALUE: ResetValue

OBSŁUGIWANE REGIONY

Lista wszystkich regionów obsługiwanych przez Cloud Functions.

Podpis:

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"]

Prawidłowe_OPCJE_PAMIĘCI

Lista dostępnych opcji pamięci obsługiwanych przez Cloud Functions.

Podpis:

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

VPC_EGRESS_SETTINGS_OPTIONS

Lista dostępnych opcji VpcConnectorEgressSettings.

Podpis:

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