https namespace

Функции

Функция Описание
onCall (обработчик) Объявляет вызываемый метод, который клиенты могут вызывать с помощью Firebase SDK.
onRequest (обработчик) Обработка HTTP-запросов.

Классы

Сорт Описание
HttpsError Явная ошибка, которая может быть вызвана обработчиком для отправки ошибки клиенту, вызвавшему функцию.

Интерфейсы

Интерфейс Описание
CallableContext Интерфейс метаданных API, передаваемых обработчику.
Запрос Экспресс-запрос с представлением тела запроса в проводном формате.

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

Введите псевдоним Описание
ФункцииErrorCode Набор кодов состояния функций Firebase. Коды такие же, как и те, которые предоставляет gRPC. .

https.onCall()

Объявляет вызываемый метод, который клиенты могут вызывать с помощью Firebase SDK.

Подпись:

export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;

Параметры

Параметр Тип Описание
обработчик (данные: любые, контекст: CallableContext ) => любой | Обещание <любое> Метод, который принимает данные и контекст и возвращает значение.

Возврат:

HttpsФункция и работоспособность <любой>

https.onRequest()

Обработка HTTP-запросов.

Подпись:

export declare function onRequest(handler: (req: Request, resp: express.Response) => void | Promise<void>): HttpsFunction;

Параметры

Параметр Тип Описание
обработчик (req: Request, соответственно: express.Response) => void | Обещание<void> Функция, которая принимает объект запроса и ответа с той же сигнатурой, что и приложение Express.

Возврат:

HttpsФункция

https.FunctionsErrorCode

Набор кодов состояния функций Firebase. Коды такие же, как и те, которые предоставляет gRPC. .

Возможные значения:

  • cancelled : операция была отменена (обычно вызывающей стороной).

  • unknown : Неизвестная ошибка или ошибка из другого домена ошибок.

  • invalid-argument : Клиент указал недопустимый аргумент. Обратите внимание, что это отличается от failed-precondition . invalid-argument указывает аргументы, которые являются проблематичными независимо от состояния системы (например, недопустимое имя поля).

  • deadline-exceeded : Срок истек до завершения операции. Для операций, изменяющих состояние системы, эта ошибка может возвращаться, даже если операция завершилась успешно. Например, успешный ответ от сервера мог быть отложен на время, достаточное для истечения крайнего срока.

  • not-found : Некоторый запрошенный документ не найден.

  • already-exists : какой-то документ, который мы пытались создать, уже существует.

  • permission-denied : у вызывающего объекта нет разрешения на выполнение указанной операции.

  • resource-exhausted : какой-то ресурс исчерпан, возможно, квота на пользователя или, возможно, во всей файловой системе недостаточно места.

  • failed-precondition : Операция отклонена, поскольку система не находится в состоянии, необходимом для выполнения операции.

  • aborted : операция была прервана, обычно из-за проблемы параллелизма, например прерывания транзакции и т. д.

  • out-of-range : Попытка выполнить операцию вышла за пределы допустимого диапазона.

  • unimplemented : Операция не реализована или не поддерживается/включена.

  • internal : Внутренние ошибки. Означает, что некоторые инварианты, ожидаемые базовой системой, нарушены. Если вы видите одну из этих ошибок, значит что-то сильно сломано.

  • unavailable : Услуга в настоящее время недоступна. Скорее всего, это временное состояние, которое можно исправить, повторив попытку с отсрочкой.

  • data-loss : Невосстановимая потеря или повреждение данных.

  • unauthenticated : запрос не содержит действительных учетных данных аутентификации для операции.

Подпись:

export type FunctionsErrorCode = "ok" | "cancelled" | "unknown" | "invalid-argument" | "deadline-exceeded" | "not-found" | "already-exists" | "permission-denied" | "resource-exhausted" | "failed-precondition" | "aborted" | "out-of-range" | "unimplemented" | "internal" | "unavailable" | "data-loss" | "unauthenticated";