Funkcje
| Funkcjonować | Opis |
|---|---|
| konfiguracja() | Przechowuj i pobieraj dane konfiguracyjne projektu, takie jak klucze API innych firm lub inne ustawienia. Możesz ustawić wartości konfiguracyjne za pomocą interfejsu wiersza polecenia Firebase, jak opisano w [Konfiguracja środowiska](/docs/functions/config-env). |
| opcjeDo punktu końcowego(opcje) | |
| opcjeToTrigger(opcje) | |
| region(regiony) | Skonfiguruj regiony, w których funkcja jest wdrożona. |
| runWith (opcje czasu wykonania) | Skonfiguruj opcje środowiska wykonawczego dla tej funkcji. |
Zajęcia
| Klasa | Opis |
|---|---|
| Zmiana | Interfejs Cloud Functions dla zdarzeń zmieniających stan, takich jak zdarzenia Realtime Database lub Cloud Firestore onWrite i onUpdate . Więcej informacji na temat formatu używanego do konstruowania obiektów Change można znaleźć poniżej. |
| Konstruktor funkcji |
Interfejsy
| Interfejs | Opis |
|---|---|
| Funkcja blokowania | Typ funkcji wyzwalaczy blokowania uwierzytelniania. |
| Funkcja chmury | Typ funkcji dla wszystkich wyzwalaczy innych niż HTTPS. Należy to wyeksportować z pliku JavaScript, aby zdefiniować funkcję chmury. Ten typ jest specjalną funkcją JavaScript, która jako jedyny argument przyjmuje obiekt Event z szablonu. |
| Opcje wdrożenia | Opcje konfiguracji funkcji, które mają zastosowanie podczas wdrażania funkcji. |
| Wydarzenie | Format przewodu dla wydarzenia. |
| Kontekst zdarzenia | Kontekst, w którym miało miejsce zdarzenie. |
| Polityka niepowodzeń | Opcja konfiguracji polityki awarii dla funkcji działających w tle. |
| Funkcja Https | Typ funkcji dla wyzwalaczy HTTPS. Należy to wyeksportować z pliku JavaScript, aby zdefiniować funkcję chmury. |
| Ratunek | Zasób to standardowy format definiowania zasobu (google.rpc.context.AttributeContext.Resource). W Cloud Functions jest to zasób, który uruchomił funkcję, na przykład zasobnik na dane. |
| Możliwość uruchomienia | Runnable ma metodę run , która bezpośrednio wywołuje funkcję zdefiniowaną przez użytkownika - przydatną do testowania jednostkowego. |
| Opcje czasu wykonania | Opcje konfiguracji funkcji, które mają zastosowanie w czasie wykonywania. |
| Harmonogram | Opcje konfiguracji zaplanowanych funkcji. |
| HarmonogramRetryConfig | Opcje ponawiania prób przez harmonogram. Dotyczy tylko zaplanowanych funkcji. |
Przestrzenie nazw
| Przestrzeń nazw | Opis |
|---|---|
| analityka | |
| autoryzacja | |
| Baza danych | |
| sklep z ogniem | |
| https | |
| rejestrator | |
| parametry | |
| pubsub | |
| zdalna konfiguracja | |
| składowanie | |
| zadania | |
| laboratorium testowe |
Zmienne
| Zmienny | Opis |
|---|---|
| aplikacja | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | Lista dostępnych opcji IngressSettings. |
| MAX_NUMBER_USER_LABELS | |
| MAX_TIMEOUT_SECONDS | Maksymalna wartość limitu czasu Cloud Functions. |
| MIN_TIMEOUT_SECONDS | Minimalna wartość limitu czasu Cloud Functions. |
| ZRESETUJ WARTOŚĆ | Specjalna wartość konfiguracyjna resetująca konfigurację do ustawień domyślnych platformy. |
| SUPPORTED_REGIONS | Lista wszystkich regionów obsługiwanych przez Cloud Functions. |
| VALID_MEMORY_OPTIONS | Lista dostępnych opcji pamięci obsługiwanych przez Cloud Functions. |
| VPC_EGRESS_SETTINGS_OPTIONS | Lista dostępnych opcji dla VpcConnectorEgressSettings. |
konfiguracja()
Przechowuj i pobieraj dane konfiguracyjne projektu, takie jak klucze API innych firm lub inne ustawienia. Możesz ustawić wartości konfiguracyjne za pomocą interfejsu wiersza polecenia Firebase, jak opisano w [Konfiguracja środowiska](/docs/functions/config-env).
Podpis:
export declare function config(): Record<string, any>;
Zwroty:
Rekord<ciąg, dowolny>
opcjeDoPunktu Końcowego()
Podpis:
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | Opcje wdrożenia |
Zwroty:
ManifestEndpoint
opcjeToTrigger()
Podpis:
export declare function optionsToTrigger(options: DeploymentOptions): any;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| opcje | Opcje wdrożenia |
Zwroty:
każdy
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<(typ SUPPORTED_REGIONS )[liczba] | ciąg | Wyrażenie <ciąg> | Zresetuj wartość> | Jeden z kolejnych ciągów regionu. |
Zwroty:
Przykład 1
funkcje.region('us-wschód1')
Przykład 2
funkcje.region('us-east1', 'us-central1')
Biegnij z()
Skonfiguruj opcje środowiska wykonawczego dla tej funkcji.
Podpis:
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| Opcje czasu wykonania | Opcje czasu wykonania | Obiekt z opcjonalnymi polami: 1. memory : ilość pamięci do przydzielenia dla funkcji, możliwe wartości to: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' i '8GB' . 2. timeoutSeconds : limit czasu funkcji w sekundach, możliwe wartości to 0 do 540. 3. failurePolicy : polityka dotycząca błędów funkcji, gdzie wartość logiczna true jest równoznaczna z udostępnieniem pustego obiektu ponownej próby. 4. vpcConnector : identyfikator złącza VPC w tym samym projekcie i regionie. 5. vpcConnectorEgressSettings : gdy ustawiony jest vpcConnector, kontroluj, jaki ruch wychodzący jest wysyłany przez vpcConnector. 6. serviceAccount : Określone konto usługi dla funkcji. 7. ingressSettings : ustawienia ingresu dla funkcji, które kontrolują, skąd można wywołać funkcję HTTPS. Wartość nie może mieć wartości null. |
Zwroty:
aplikacja
Podpis:
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
DEFAULT_FAILURE_POLICY
Podpis:
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
Lista dostępnych opcji IngressSettings.
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 Cloud Functions.
Podpis:
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Minimalna wartość limitu czasu Cloud Functions.
Podpis:
MIN_TIMEOUT_SECONDS = 0
ZRESETUJ WARTOŚĆ
Specjalna wartość konfiguracyjna resetująca konfigurację do ustawień domyślnych platformy.
Podpis:
RESET_VALUE: ResetValue
SUPPORTED_REGIONS
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"]
VALID_MEMORY_OPTIONS
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 dla VpcConnectorEgressSettings.
Podpis:
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]