firebase-functions package

Функции

Функция	Описание
конфигурация()	Храните и извлекайте данные конфигурации проекта, такие как сторонние ключи API или другие настройки. Вы можете установить значения конфигурации с помощью интерфейса командной строки Firebase, как описано в [Конфигурация среды](/docs/functions/config-env).
optionsToEndpoint(опции)
optionsToTrigger(варианты)
регион(регионы)	Настройте регионы, в которых будет развернута функция.
runWith (параметры выполнения)	Настройте параметры времени выполнения для функции.

Классы

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

Интерфейсы

Интерфейс	Описание
Блокирующая функция	Тип функции для триггеров блокировки аутентификации.
Облачная функция	Тип функции для всех триггеров, отличных от HTTPS. Его следует экспортировать из вашего файла JavaScript, чтобы определить облачную функцию. Этот тип представляет собой специальную функцию JavaScript, которая принимает шаблонный объект Event в качестве единственного аргумента.
Параметры развертывания	Параметры конфигурации функции, которые применяются во время развертывания функции.
Событие	Формат телеграммы на мероприятие.
Контекст события	Контекст, в котором произошло событие.
Политика отказа	Параметр конфигурации для политики сбоев в фоновых функциях.
HttpsФункция	Тип функции для триггеров HTTPS. Его следует экспортировать из вашего файла JavaScript, чтобы определить облачную функцию.
Ресурс	Ресурс – это стандартный формат определения ресурса (google.rpc.context.AttributeContext.Resource). В облачных функциях это ресурс, который активировал функцию, например сегмент хранилища.
работоспособный	Runnable имеет метод run , который напрямую вызывает определяемую пользователем функцию, что полезно для модульного тестирования.
Параметры выполнения	Параметры конфигурации функции, применимые во время выполнения.
Расписание	Параметры конфигурации запланированных функций.
РасписаниеRetryConfig	Параметры повтора планировщика. Применяется только к запланированным функциям.

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

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

Переменные

Переменная	Описание
приложение
DEFAULT_FAILURE_POLICY
INGRESS_SETTINGS_OPTIONS	Список доступных параметров IngressSettings.
MAX_NUMBER_USER_LABELS
MAX_TIMEOUT_SECONDS	Максимальное значение тайм-аута облачных функций.
MIN_TIMEOUT_SECONDS	Минимальное значение тайм-аута облачных функций.
RESET_VALUE	Специальное значение конфигурации для сброса конфигурации до настроек платформы по умолчанию.
ПОДДЕРЖИВАЕМЫЕ_РЕГИОНЫ	Список всех регионов, поддерживаемых облачными функциями.
VALID_MEMORY_OPTIONS	Список доступных вариантов памяти, поддерживаемых облачными функциями.
VPC_EGRESS_SETTINGS_OPTIONS	Список доступных параметров для VpcConnectorEgressSettings.

конфигурация()

Храните и извлекайте данные конфигурации проекта, такие как сторонние ключи API или другие настройки. Вы можете установить значения конфигурации с помощью интерфейса командной строки Firebase, как описано в [Конфигурация среды](/docs/functions/config-env).

Подпись:

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

Возврат:

Запись<строка, любая>

ОпцииToEndpoint()

Подпись:

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

Параметры

Параметр	Тип	Описание
параметры	Параметры развертывания

Возврат:

Конечная точка манифеста

ОпцииToTrigger()

Подпись:

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

Параметры

Параметр	Тип	Описание
параметры	Параметры развертывания

Возврат:

любой

область()

Настройте регионы, в которых будет развернута функция.

Подпись:

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

Параметры

Параметр	Тип	Описание
регионы	Массив<(тип SUPPORTED_REGIONS )[число] | строка | Выражение <строка> | СбросЗначения>	Одна или несколько строк региона.

Возврат:

FunctionBuilder

Пример 1

функции.регион('us-east1')

Пример 2

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

запуститьС()

Настройте параметры времени выполнения для функции.

Подпись:

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

Параметры

Параметр	Тип	Описание
Параметры времени выполнения	Параметры выполнения	Объект с необязательными полями: 1. memory : объем памяти, выделяемый для функции, возможные значения: «128 МБ», «256 МБ», «512 МБ», «1 ГБ», «2 ГБ», «4 ГБ» и «8 ГБ». . 2. timeoutSeconds : таймаут функции в секундах, возможные значения от 0 до 540. 3. failurePolicy : политика отказа функции, где логическое значение true эквивалентно предоставлению пустого объекта повтора. 4. vpcConnector : идентификатор соединителя VPC в том же проекте и регионе. 5. vpcConnectorEgressSettings : если установлен vpcConnector, можно контролировать, какой исходящий трафик будет отправляться через vpcConnector. 6. serviceAccount : конкретная учетная запись службы для функции. 7. ingressSettings : настройки входа для функции, которые определяют, откуда может быть вызвана функция HTTPS. Значение не должно быть нулевым.

Возврат:

FunctionBuilder

приложение

Подпись:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

DEFAULT_FAILURE_POLICY

Подпись:

DEFAULT_FAILURE_POLICY: FailurePolicy

INGRESS_SETTINGS_OPTIONS

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

Подпись:

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

MAX_NUMBER_USER_LABELS

Подпись:

MAX_NUMBER_USER_LABELS = 58

MAX_TIMEOUT_SECONDS

Максимальное значение тайм-аута облачных функций.

Подпись:

MAX_TIMEOUT_SECONDS = 540

MIN_TIMEOUT_SECONDS

Минимальное значение тайм-аута облачных функций.

Подпись:

MIN_TIMEOUT_SECONDS = 0

RESET_VALUE

Специальное значение конфигурации для сброса конфигурации к настройкам платформы по умолчанию.

Подпись:

RESET_VALUE: ResetValue

ПОДДЕРЖИВАЕМЫЕ_РЕГИОНЫ

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

Подпись:

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

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

Подпись:

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

VPC_EGRESS_SETTINGS_OPTIONS

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

Подпись:

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