https namespace

Funciones

Función Descripción
onCall(opta, controlador) Declara un método invocable para que los clientes lo llamen mediante un SDK de Firebase.
onCall (controlador) Declara un método invocable para que los clientes lo llamen mediante un SDK de Firebase.
onRequest(opta, controlador) Maneja solicitudes HTTPS.
onRequest(controlador) Maneja solicitudes HTTPS.

Clases

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

Interfaces

Interfaz Descripción
Función invocable Crea un método invocable para que los clientes lo llamen mediante un SDK de Firebase.
Opciones invocables Opciones que se pueden configurar en una función HTTPS invocable.
Solicitud invocable La solicitud utilizada para llamar a una función invocable.
Opciones HTTPS Opciones que se pueden configurar en una función HTTPS onRequest.
Pedido Una solicitud expresa con la representación en formato cable del cuerpo de la solicitud.

Tipo de alias

Tipo Alias Descripción
FuncionesCódigo de error El conjunto de códigos de estado de Firebase Functions. Los códigos son los mismos que los expuestos por gRPC . .
Función Https Maneja solicitudes HTTPS.

https.onCall()

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

Firma:

export declare function onCall<T = any, Return = any | Promise<any>>(opts: CallableOptions, handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parámetros

Parámetro Tipo Descripción
opta Opciones invocables Opciones para configurar en esta función.
manipulador (solicitud: Solicitud invocable <T>) => Volver Una función que toma un https.CallableRequest .

Devoluciones:

Función invocable<T, retorno>

Una función que puedes exportar e implementar.

https.onCall()

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

Firma:

export declare function onCall<T = any, Return = any | Promise<any>>(handler: (request: CallableRequest<T>) => Return): CallableFunction<T, Return>;

Parámetros

Parámetro Tipo Descripción
manipulador (solicitud: Solicitud invocable <T>) => Volver Una función que toma un https.CallableRequest .

Devoluciones:

Función invocable<T, retorno>

Una función que puedes exportar e implementar.

https.onRequest()

Maneja solicitudes HTTPS.

Firma:

export declare function onRequest(opts: HttpsOptions, handler: (request: Request, response: express.Response) => void | Promise<void>): HttpsFunction;

Parámetros

Parámetro Tipo Descripción
opta Opciones HTTPS Opciones para configurar en esta función
manipulador (solicitud: Solicitud , respuesta: express.Response) => void | Promesa<nulo> Una función que toma un objeto https.Request y respuesta, la misma firma que una aplicación Express.

Devoluciones:

Función Https

Una función que puedes exportar e implementar.

https.onRequest()

Maneja solicitudes HTTPS.

Firma:

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

Parámetros

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

Devoluciones:

Función Https

Una función que puedes exportar e implementar.

https.FuncionesErrorCode

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 se pudiera completar la operación. Para operaciones que cambian el estado del sistema, este error puede aparecer incluso si la operación se completó exitosamente. Por ejemplo, una respuesta exitosa de un servidor podría haberse retrasado lo suficiente como para que expirara el plazo.

  • not-found : Algún documento solicitado no fue encontrado.

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

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

  • resource-exhausted : Algún recurso se ha agotado, quizás una cuota por usuario o quizás todo el sistema de archivos se haya quedado sin espacio.

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

  • aborted : la operación se canceló, generalmente debido a un problema de simultaneidad como transacciones canceladas, etc.

  • out-of-range : Se intentó realizar 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 ve 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 de datos irrecuperables.

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

https.HttpsFunción

Maneja solicitudes HTTPS.

Firma:

export type HttpsFunction = ((
req: Request, 
res: express.Response) => void | Promise<void>) & {
    __trigger?: unknown;
    __endpoint: ManifestEndpoint;
};