functions package

Облачные функции для Firebase

Функции

Функция Описание
функция (приложение, ...)
getFunctions (приложение, регионOrCustomDomain) Возвращает экземпляр Functions для данного приложения.
функция (экземпляр функции, ...)
ConnectFunctionsEmulator (functionsInstance, хост, порт) Измените этот экземпляр для взаимодействия с эмулятором Cloud Functions. Примечание. Это необходимо вызвать до того, как этот экземпляр будет использоваться для выполнения каких-либо операций.
httpsCallable (экземпляр функции, имя, параметры) Возвращает ссылку на вызываемый триггер HTTPS с заданным именем.
httpsCallableFromURL (functionsInstance, URL, параметры) Возвращает ссылку на вызываемый триггер HTTPS с указанным URL-адресом.

Интерфейсы

Интерфейс Описание
Функции Экземпляр Functions .
ФункцииОшибка Ошибка, возвращаемая клиентским SDK Firebase Functions.
HttpsCallableOptions Интерфейс для метаданных о том, как следует выполнять вызовы.
HttpsCallableResult HttpsCallableResult оборачивает один результат вызова функции.

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

Введите псевдоним Описание
ФункцииErrorCode Набор кодов состояния функций Firebase. Коды такие же, как и те, которые предоставляет gRPC здесь: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md. Возможные значения: - «отменено»: операция была отменена (обычно вызывающей стороной). - «неизвестно»: неизвестная ошибка или ошибка из другого домена ошибок. - «неверный аргумент»: клиент указал недопустимый аргумент. Обратите внимание, что это отличается от «неудачного предварительного условия». 'invalid-argument' указывает аргументы, которые являются проблематичными независимо от состояния системы (например, недопустимое имя поля). - «крайний срок превышен»: срок истек до завершения операции. Для операций, изменяющих состояние системы, эта ошибка может возвращаться, даже если операция завершилась успешно. Например, успешный ответ от сервера мог быть отложен на время, достаточное для истечения крайнего срока. - «не найден»: некоторый запрошенный документ не найден. - «уже существует»: некоторый документ, который мы пытались создать, уже существует. - 'permission-denied': вызывающая сторона не имеет разрешения на выполнение указанной операции. - «ресурс исчерпан»: какой-то ресурс исчерпан, возможно, квота на пользователя или, возможно, во всей файловой системе недостаточно места. - «неудачное предварительное условие»: операция была отклонена, поскольку система не находится в состоянии, необходимом для выполнения операции. - «прервано»: операция была прервана, обычно из-за проблемы параллелизма, например, прерывания транзакций и т. д. - «вне диапазона»: попытка выполнения операции вышла за пределы допустимого диапазона. - «не реализовано»: операция не реализована или не поддерживается/включена. - «внутренний»: внутренние ошибки. Означает, что некоторые инварианты, ожидаемые базовой системой, нарушены. Если вы видите одну из этих ошибок, значит что-то сильно сломано. - «недоступно»: услуга в настоящее время недоступна. Скорее всего, это временное состояние, которое можно исправить, повторив попытку с отсрочкой. - «потеря данных»: невосстановимая потеря или повреждение данных. - «неаутентифицированный»: запрос не имеет действительных учетных данных аутентификации для операции.
ФункцииErrorCodeCore Строка кода ошибки функций добавляется после префикса продукта "functions/". См. FunctionsErrorCode для получения полной документации по кодам.
HttpsCallable Ссылка на «вызываемый» HTTP-триггер в Google Cloud Functions.

функция (приложение, ...)

getFunctions (приложение, регионOrCustomDomain)

Возвращает экземпляр Functions для данного приложения.

Подпись: 

export declare function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

Параметры

Параметр Тип Описание
приложение FirebaseApp Используемое приложение FirebaseApp .
регионОрCustomDomain нить одно из: a) Регион, в котором расположены вызываемые функции (например: us-central1) b) Пользовательский домен, на котором размещаются вызываемые функции (например: https://mydomain.com)

Возврат:

Функции

функция (экземпляр функции, ...)

ConnectFunctionsEmulator (functionsInstance, хост, порт)

Измените этот экземпляр для взаимодействия с эмулятором Cloud Functions.

Подпись: 

export declare function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

Параметры

Параметр Тип Описание
функцииЭкземпляр Функции
хозяин нить Хост эмулятора (например: localhost)
порт число Порт эмулятора (например: 5001)

Возврат:

пустота

httpsCallable (экземпляр функции, имя, параметры)

Возвращает ссылку на вызываемый триггер HTTPS с заданным именем.

Подпись: 

export declare function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Параметры

Параметр Тип Описание
функцииЭкземпляр Функции
имя нить Имя триггера.
параметры HttpsCallableOptions

Возврат:

HttpsCallable <Данные запроса, Данные ответа>

httpsCallableFromURL (functionsInstance, URL, параметры)

Возвращает ссылку на вызываемый триггер HTTPS с указанным URL-адресом.

Подпись: 

export declare function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

Параметры

Параметр Тип Описание
функцииЭкземпляр Функции
URL нить URL-адрес триггера.
параметры HttpsCallableOptions

Возврат:

HttpsCallable <Данные запроса, Данные ответа>

ФункцииErrorCode

Набор кодов состояния функций Firebase. Коды такие же, как и те, которые предоставляет gRPC здесь: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md.

Возможные значения: - «отменено»: операция была отменена (обычно вызывающей стороной). - «неизвестно»: неизвестная ошибка или ошибка из другого домена ошибок. - «неверный аргумент»: клиент указал недопустимый аргумент. Обратите внимание, что это отличается от «неудачного предварительного условия». 'invalid-argument' указывает аргументы, которые являются проблематичными независимо от состояния системы (например, недопустимое имя поля). - «крайний срок превышен»: срок истек до завершения операции. Для операций, изменяющих состояние системы, эта ошибка может возвращаться, даже если операция завершилась успешно. Например, успешный ответ от сервера мог быть отложен на время, достаточное для истечения крайнего срока. - «не найден»: некоторый запрошенный документ не найден. - «уже существует»: некоторый документ, который мы пытались создать, уже существует. - 'permission-denied': вызывающая сторона не имеет разрешения на выполнение указанной операции. - «ресурс исчерпан»: какой-то ресурс исчерпан, возможно, квота на пользователя или, возможно, во всей файловой системе недостаточно места. - «неудачное предварительное условие»: операция была отклонена, поскольку система не находится в состоянии, необходимом для выполнения операции. - «прервано»: операция была прервана, обычно из-за проблемы параллелизма, например, прерывания транзакций и т. д. - «вне диапазона»: попытка выполнения операции вышла за пределы допустимого диапазона. - «не реализовано»: операция не реализована или не поддерживается/включена. - «внутренний»: внутренние ошибки. Означает, что некоторые инварианты, ожидаемые базовой системой, нарушены. Если вы видите одну из этих ошибок, значит что-то сильно сломано. - «недоступно»: услуга в настоящее время недоступна. Скорее всего, это временное состояние, которое можно исправить, повторив попытку с отсрочкой. - «потеря данных»: невосстановимая потеря или повреждение данных. - «неаутентифицированный»: запрос не имеет действительных учетных данных аутентификации для операции.

Подпись: 

export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

ФункцииErrorCodeCore

Строка кода ошибки функций добавляется после префикса продукта "functions/". См. FunctionsErrorCode для получения полной документации по кодам.

Подпись: 

export declare type FunctionsErrorCodeCore = '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';

HttpsCallable

Ссылка на «вызываемый» HTTP-триггер в Google Cloud Functions.

Подпись:

export declare type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;