firebase-admin.functions package

Сервис функций Firebase.

Функции

Функция	Описание
getFunctions (приложение)	Получает службу функций для приложения по умолчанию или заданного приложения. getFunctions() можно вызвать без аргументов для доступа к службе Functions приложения по умолчанию или как getFunctions(app) для доступа к службе Functions , связанной с конкретным приложением.

Классы

Сорт	Описание
Функции	Сервисный интерфейс Firebase Functions .
Очередь задач	Интерфейс TaskQueue .

Интерфейсы

Интерфейс	Описание
АбсолютнаяДоставка	Интерфейс, представляющий варианты задач с абсолютной доставкой.
Задержка доставки	Интерфейс, представляющий варианты задач с отложенной доставкой.
Параметры задачиЭкспериментальный	Тип, представляющий экспериментальные (бета-версии) варианты задач.

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

Введите псевдоним	Описание
График доставки	Введите, представляющий варианты графика доставки. DeliverySchedule — это тип объединения типов DelayDelivery и AbsoluteDelivery .
Параметры задачи	Введите, представляющий параметры задачи.

getFunctions (приложение)

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

getFunctions() можно вызвать без аргументов для доступа к службе Functions приложения по умолчанию или как getFunctions(app) для доступа к службе Functions , связанной с конкретным приложением.

Подпись:

export declare function getFunctions(app?: App): Functions;

Параметры

Параметр	Тип	Описание
приложение	Приложение	Необязательное приложение, для которого возвращается служба Functions . Если он не указан, возвращается служба Functions по умолчанию.

Возврат:

Функции

Служба Functions по умолчанию, если приложение не предоставлено, или служба Functions , связанная с предоставленным приложением.

Пример 1

// Get the `Functions` service for the default app
const defaultFunctions = getFunctions();

Пример 2

// Get the `Functions` service for a given app
const otherFunctions = getFunctions(otherApp);

График доставки

Введите, представляющий варианты графика доставки. DeliverySchedule — это тип объединения типов DelayDelivery и AbsoluteDelivery .

Подпись:

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

Параметры задачи

Введите, представляющий параметры задачи.

Подпись:

export type TaskOptions = DeliverySchedule & TaskOptionsExperimental & {
    dispatchDeadlineSeconds?: number;
    id?: string;
    headers?: Record<string, string>;
};