https namespace

Funciones

Función Descripción
onCall(controlador) Declara un método que admite llamadas para que los clientes lo llamen con un SDK de Firebase.
onRequest(controlador) Maneja solicitudes HTTP.

Clases

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

Interfaces

Interfaz Descripción
CallableContext La interfaz de los metadatos de la API como se pasa al controlador.
Solicitud Una solicitud explícita con la representación en formato de conexión del cuerpo de la solicitud.

Escribe alias

Alias de tipo Descripción
FunctionsErrorCode Es el conjunto de códigos de estado de Firebase Functions. Los códigos son los mismos que los que expone gRPC.

https.onCall().

Declara un método que admite llamadas para que los clientes lo llamen con 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
handler (datos: any, contexto: CallableContext) => cualquier | Promesa<cualquiera> Es un método que toma datos y contexto, y muestra un valor.

Muestra:

HttpsFunction y Ejecutable<any>

https.onRequest().

Maneja solicitudes HTTP.

Firma:

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

Parámetros

Parámetro Tipo Descripción
handler (req: Request, resp: express.Response) => void | Promesa<void> Una función que toma una solicitud y un objeto de respuesta, con la misma firma que una app de Express.

Muestra:

HttpsFunction

https.FunctionsErrorCode.

Es el conjunto de códigos de estado de Firebase Functions. Los códigos son los mismos que los que expone gRPC.

Valores posibles:

  • cancelled: Se canceló la operación (por lo general, la cancela el llamador).

  • unknown: Error desconocido o proveniente de otro dominio de errores.

  • invalid-argument: El cliente especificó un argumento no válido. Ten en cuenta que es diferente de failed-precondition. invalid-argument indica los argumentos que son problemáticos sin importar el estado del sistema (p.ej., un nombre de campo no válido).

  • deadline-exceeded: La fecha límite venció antes de que la operación se pudiera completar. En el caso de las operaciones que cambian el estado del sistema, es probable que se muestre este error incluso si la operación se completó correctamente. Por ejemplo, una respuesta correcta desde un servidor podría haberse retrasado lo suficiente como para que el plazo venciera.

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

  • already-exists: Algún documento que intentamos crear ya existe.

  • permission-denied: El llamador no tiene permiso para ejecutar la operación especificada.

  • resource-exhausted: Se agotaron algunos recursos, tal vez una cuota por usuario, o tal vez se agotó el espacio de todo el sistema de archivos.

  • failed-precondition: Se rechazó la operación porque el sistema no se encuentra en un estado necesario para la ejecución de la operación.

  • aborted: Se anuló la operación, por lo general, debido a un problema de simultaneidad, como las anulaciones de transacciones, etcétera.

  • out-of-range: La operación se intentó fuera del rango válido.

  • unimplemented: La operación no se implementó, no está habilitada o no se admite.

  • internal: Errores internos. Indica que algunas variantes que espera el sistema subyacente no funcionan. Si ves uno de estos errores, significa que hay un problema grave.

  • unavailable: El servicio no está disponible en este momento. Lo más probable es que esta sea una condición transitoria y se pueda corregir si vuelves a intentar con una retirada.

  • data-loss: Daño o pérdida de datos irrecuperable.

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