firebase-functions package

API второго поколения для облачных функций для Firebase. Этот SDK поддерживает глубокий импорт. Например, пространство имен pubsub доступно по адресу firebase-functions/v2 или его можно напрямую импортировать из firebase-functions/v2/pubsub .

Функции

Функция Описание
setGlobalOptions (опции) Устанавливает параметры по умолчанию для всех функций, написанных с использованием SDK 2-го поколения.

Классы

Сорт Описание
Изменять Интерфейс облачных функций для событий, которые меняют состояние, таких как события onWrite и onUpdate для базы данных реального времени или Cloud Firestore. Дополнительные сведения о формате, используемом для создания объектов Change , см. ниже.

Интерфейсы

Интерфейс Описание
CloudEvent (БЕТА) CloudEventBase — это основа кроссплатформенного формата для кодирования бессерверных событий. Для получения дополнительной информации см. https://github.com/cloudevents/spec.
Облачная функция (БЕТА) Обработчик CloudEvents.
EventHandlerOptions Дополнительные поля, которые можно задать для любой функции обработки событий.
Глобальные параметры GlobalOptions — это параметры, которые можно установить для всего проекта. Эти параметры являются общими для HTTPS и функций обработки событий.

Пространства имен

Пространство имен Описание
оповещения
база данных
событие
пожарная лавка
https
личность
лесоруб
параметры
пабсаб
удаленнаяконфигурация
планировщик
хранилище
задания
тестовая лаборатория

Введите псевдонимы

Введите псевдоним Описание
IngressSetting Список доступных опций для IngressSettings .
Опция памяти Список доступных вариантов памяти, поддерживаемых облачными функциями.
ПарамсОф Тип, который отображает все группы захвата параметров в ключи записи. Например, ПарамсОф < "пользователи/ { жидкость } " > есть { uid: строка } ParamsOf < "пользователи/ { жидкость } /журналы/ { бревно } " > есть {UID: строка; журнал: строка } ParamsOf < "некоторые/статические/данные" > это { } Из соображений гибкости ParamsOf это запись < веревка, веревка >
Поддерживаемый регион Список всех регионов, поддерживаемых облачными функциями (2-го поколения).
Настройка VpcEgressSetting Список доступных опций для VpcConnectorEgressSettings .

setGlobalOptions()

Устанавливает параметры по умолчанию для всех функций, написанных с использованием SDK 2-го поколения.

Подпись:

export declare function setGlobalOptions(options: GlobalOptions): void;

Параметры

Параметр Тип Описание
параметры Глобальные параметры Параметры, которые можно установить по умолчанию

Возврат:

пустота

IngressSetting

Список доступных опций для IngressSettings .

Подпись:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

Опция памяти

Список доступных вариантов памяти, поддерживаемых облачными функциями.

Подпись:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

ПарамсОф

Тип, который отображает все группы захвата параметров в ключи записи. Например, ПарамсОф < "пользователи/ { жидкость } " > есть { uid: строка } ParamsOf < "пользователи/ { жидкость } /журналы/ { бревно } " > есть {UID: строка; журнал: строка } ParamsOf < "некоторые/статические/данные" > это { }

Из соображений гибкости ParamsOf это запись < веревка, веревка >

Подпись:

export type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
};

Поддерживаемый регион

Список всех регионов, поддерживаемых облачными функциями (2-го поколения).

Подпись:

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

Настройка VpcEgressSetting

Список доступных параметров для VpcConnectorEgressSettings .

Подпись:

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