functions package

Funciones en la nube para Firebase

Funciones

Función Descripción
función (aplicación, ...)
getFunctions(aplicación, regiónOrCustomDomain) Devuelve una instancia de Functions para la aplicación dada.
función(funcionesInstancia, ...)
connectFunctionsEmulator(funcionesInstancia, host, puerto) Modifique esta instancia para comunicarse con el emulador de Cloud Functions. Nota: esto debe llamarse antes de que esta instancia se haya utilizado para realizar cualquier operación.
httpsCallable(funcionesInstancia, nombre, opciones) Devuelve una referencia al desencadenador HTTPS invocable con el nombre indicado.
httpsCallableFromURL(funcionesInstancia, URL, opciones) Devuelve una referencia al desencadenador HTTPS invocable con la URL especificada.

Interfaces

Interfaz Descripción
Funciones Una instancia Functions .
FuncionesError Un error devuelto por el SDK del cliente de Firebase Functions.
HttpsCallableOptions Una interfaz para metadatos sobre cómo se deben ejecutar las llamadas.
HttpsCallableResultado Un HttpsCallableResult envuelve un único resultado de una llamada de función.

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 aquí: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Valores posibles: - 'cancelado': la operación fue cancelada (normalmente por la persona que llama). - 'desconocido': error desconocido o error de un dominio de error diferente. - 'argumento-inválido': el cliente especificó un argumento no válido. Tenga en cuenta que esto difiere de la "condición previa fallida". 'argumento-inválido' indica argumentos que son problemáticos independientemente del estado del sistema (por ejemplo, un nombre de campo no válido). - 'fecha límite excedida': la fecha límite 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. - 'no encontrado': No se encontró algún documento solicitado. - 'ya-existe': Algún documento que intentamos crear ya existe. - 'permiso denegado': la persona que llama no tiene permiso para ejecutar la operación especificada. - 'recursos agotados': 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. - 'precondición fallida': La operación fue rechazada porque el sistema no se encuentra en el estado requerido para la ejecución de la operación. - 'abortada': la operación fue abortada, generalmente debido a un problema de concurrencia como transacciones abortadas, etc. - 'fuera de rango': la operación se intentó más allá del rango válido. - 'no implementado': la operación no está implementada o no es compatible/habilitada. - 'interno': Errores internos. Significa que se han roto algunas invariantes esperadas por el sistema subyacente. Si ve uno de estos errores, algo está muy roto. - 'no disponible': 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. - 'pérdida de datos': pérdida o corrupción de datos irrecuperables. - 'no autenticado': La solicitud no tiene credenciales de autenticación válidas para la operación.
FuncionesErrorCodeCore Cadena de código de error de funciones agregada después del prefijo del producto "funciones/". Consulte FunctionsErrorCode para obtener documentación completa de los códigos.
HttpsInvocable Una referencia a un activador HTTP "invocable" en Google Cloud Functions.

función (aplicación, ...)

getFunctions(aplicación, regiónOrCustomDomain)

Devuelve una instancia de Functions para la aplicación dada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase La FirebaseApp que se utilizará.
región o dominio personalizado cadena uno de: a) La región en la que se encuentran las funciones invocables (por ejemplo: us-central1) b) Un dominio personalizado que aloja las funciones invocables (por ejemplo: https://mydomain.com)

Devoluciones:

Funciones

función(funcionesInstancia, ...)

connectFunctionsEmulator(funcionesInstancia, host, puerto)

Modifique esta instancia para comunicarse con el emulador de Cloud Functions.

Firma:

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

Parámetros

Parámetro Tipo Descripción
funciones Instancia Funciones
anfitrión cadena El host del emulador (por ejemplo: localhost)
puerto número El puerto del emulador (ej: 5001)

Devoluciones:

vacío

httpsCallable(funcionesInstancia, nombre, opciones)

Devuelve una referencia al desencadenador HTTPS invocable con el nombre indicado.

Firma:

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

Parámetros

Parámetro Tipo Descripción
funciones Instancia Funciones
nombre cadena El nombre del desencadenante.
opciones HttpsCallableOptions

Devoluciones:

HttpsInvocable <Datos de solicitud, Datos de respuesta>

httpsCallableFromURL(funcionesInstancia, URL, opciones)

Devuelve una referencia al desencadenador HTTPS invocable con la URL especificada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
funciones Instancia Funciones
URL cadena La URL del desencadenante.
opciones HttpsCallableOptions

Devoluciones:

HttpsInvocable <Datos de solicitud, Datos de respuesta>

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 aquí: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Valores posibles: - 'cancelado': la operación fue cancelada (normalmente por la persona que llama). - 'desconocido': error desconocido o error de un dominio de error diferente. - 'argumento-inválido': el cliente especificó un argumento no válido. Tenga en cuenta que esto difiere de la "condición previa fallida". 'argumento-inválido' indica argumentos que son problemáticos independientemente del estado del sistema (por ejemplo, un nombre de campo no válido). - 'fecha límite excedida': la fecha límite 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. - 'no encontrado': No se encontró algún documento solicitado. - 'ya-existe': Algún documento que intentamos crear ya existe. - 'permiso denegado': la persona que llama no tiene permiso para ejecutar la operación especificada. - 'recursos agotados': 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. - 'precondición fallida': La operación fue rechazada porque el sistema no se encuentra en el estado requerido para la ejecución de la operación. - 'abortada': la operación fue abortada, generalmente debido a un problema de concurrencia como transacciones abortadas, etc. - 'fuera de rango': la operación se intentó más allá del rango válido. - 'no implementado': la operación no está implementada o no es compatible/habilitada. - 'interno': Errores internos. Significa que se han roto algunas invariantes esperadas por el sistema subyacente. Si ve uno de estos errores, algo está muy roto. - 'no disponible': 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. - 'pérdida de datos': pérdida o corrupción de datos irrecuperables. - 'no autenticado': La solicitud no tiene credenciales de autenticación válidas para la operación.

Firma:

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

FuncionesErrorCodeCore

Cadena de código de error de funciones agregada después del prefijo del producto "funciones/". Consulte FunctionsErrorCode para obtener documentación completa de los códigos.

Firma:

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

HttpsInvocable

Una referencia a un activador HTTP "invocable" en Google Cloud Functions.

Firma:

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