https namespace

Funciones

Función Descripción
en llamada (controlador) Declara un método invocable para que los clientes llamen mediante un SDK de Firebase.
onRequest(manejador) Manejar solicitudes HTTP.

Clases

Clase Descripción
HttpsError Un error explícito que se puede generar desde un controlador para enviar un error al cliente que llamó a la función.

Interfaces

Interfaz Descripción
CallableContext La interfaz para los metadatos de la API tal como se pasa al controlador.
Pedido Una solicitud expresa con la representación en formato electrónico del cuerpo de la solicitud.

Tipo de alias

Alias ​​de tipo Descripción
FunctionsErrorCode El conjunto de códigos de estado de Firebase Functions. Los códigos son los mismos que los expuestos por gRPC .

https.onCall()

Declara un método invocable para que los clientes llamen mediante un SDK de Firebase.

Firma:

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

Parámetros

Parámetro Tipo Descripción
manipulador (datos: cualquiera, contexto: CallableContext ) => cualquier | Promesa <cualquiera> Un método que toma datos y contexto y devuelve un valor.

Devoluciones:

Función Https y ejecutable <cualquiera>

https.onRequest()

Manejar solicitudes HTTP.

Firma:

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

Parámetros

Parámetro Tipo Descripción
manipulador (req: Solicitud, resp: express.Response) => void | Promesa <vacío> Una función que toma un objeto de solicitud y respuesta, la misma firma que una aplicación Express.

Devoluciones:

Función Https

https.FunctionsErrorCode

El conjunto de códigos de estado de Firebase Functions. Los códigos son los mismos que los expuestos por gRPC .

Valores posibles:

  • cancelled : La operación fue cancelada (normalmente por la persona que llama).

  • unknown : Error desconocido o un error de un dominio de error diferente.

  • invalid-argument : El cliente especificó un argumento no válido. Tenga en cuenta que esto difiere de failed-precondition . invalid-argument indica argumentos que son problemáticos independientemente del estado del sistema (por ejemplo, un nombre de campo no válido).

  • deadline-exceeded : El plazo expiró antes de que pudiera completarse la operación. Para las operaciones que cambian el estado del sistema, este error puede devolverse incluso si la operación se completó correctamente. Por ejemplo, una respuesta satisfactoria de un servidor podría haberse retrasado lo suficiente como para que caducara el plazo.

  • not-found : No se encontró algún documento solicitado.

  • already-exists : Ya existe algún documento que intentamos crear.

  • permission-denied : La persona que llama no tiene permiso para ejecutar la operación especificada.

  • resource-exhausted : Se ha agotado algún recurso, tal vez una cuota por usuario, o tal vez todo el sistema de archivos se haya quedado sin espacio.

  • failed-precondition : La operación fue rechazada porque el sistema no está en el estado requerido para la ejecución de la operación.

  • aborted : La operación se anuló, generalmente debido a un problema de concurrencia, como cancelaciones de transacciones, etc.

  • out-of-range : Se intentó la operación más allá del rango válido.

  • unimplemented : La operación no está implementada o no es compatible/habilitada.

  • internal : Errores internos. Significa que se han roto algunas invariantes esperadas por el sistema subyacente. Si ves uno de estos errores, algo está muy roto.

  • unavailable : El servicio no está disponible actualmente. Lo más probable es que se trate de una condición transitoria y se puede corregir volviendo a intentarlo con un retroceso.

  • data-loss : Pérdida o corrupción irrecuperable de datos.

  • unauthenticated : La solicitud no tiene credenciales de autenticación válidas para la operación.

Firma:

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