functions package

Funciones en la nube para Firebase

Funciones

Función Descripción
función (aplicación...)
getFunctions (aplicación, región o dominio personalizado) Devuelve una instancia de Functions para la aplicación dada.
function(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 disparador HTTPS invocable con el nombre dado.
httpsCallableFromURL(funcionesInstancia, url, opciones) Devuelve una referencia al activador HTTPS invocable con la URL especificada.

Interfaces

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

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 aquí: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Valores posibles: - 'cancelado': La operación fue cancelada (típicamente por la persona que llama). - 'desconocido': error desconocido o un error de un dominio de error diferente. - 'argumento no válido': el cliente especificó un argumento no válido. Tenga en cuenta que esto difiere de 'precondición fallida'. 'argumento no vá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 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. - '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. - 'resource-exhausted': se ha agotado algún recurso, tal vez una cuota por usuario, o tal vez todo el sistema de archivos no tiene 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. - 'abortado': la operación se canceló, generalmente debido a un problema de concurrencia, como cancelaciones de transacciones, 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 ves 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.
FunctionsErrorCodeCore Cadena de código de error de funciones añadida después del prefijo de producto "funciones/". Consulte FunctionsErrorCode para obtener la documentación completa de los códigos.
Https Llamable Una referencia a un activador HTTP "invocable" en Google Cloud Functions.

obtenerFunciones()

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 FirebaseApp La FirebaseApp a usar.
regionOrCustomDomain cadena uno de: a) La región en la que se encuentran las funciones invocables (p. ej., us-central1) b) Un dominio personalizado que aloja las funciones invocables (p. ej., https://mydomain.com)

Devoluciones:

Funciones

conectarFuncionesEmulador()

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
funcionesInstancia Funciones
anfitrión cadena El host del emulador (por ejemplo: localhost)
puerto número El puerto del emulador (ej: 5001)

Devoluciones:

vacío

httpsLlamable()

Devuelve una referencia al disparador HTTPS invocable con el nombre dado.

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
funcionesInstancia Funciones
nombre cadena El nombre del activador.
opciones HttpsCalableOptions

Devoluciones:

Https Llamable <Datos de Solicitud, Datos de Respuesta>

httpsLlamableDesdeURL()

Devuelve una referencia al activador 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
funcionesInstancia Funciones
URL cadena La URL del activador.
opciones HttpsCalableOptions

Devoluciones:

Https Llamable <Datos de Solicitud, Datos de Respuesta>

FunctionsErrorCode

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 (típicamente por la persona que llama). - 'desconocido': error desconocido o un error de un dominio de error diferente. - 'argumento no válido': el cliente especificó un argumento no válido. Tenga en cuenta que esto difiere de 'precondición fallida'. 'argumento no vá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 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. - '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. - 'resource-exhausted': se ha agotado algún recurso, tal vez una cuota por usuario, o tal vez todo el sistema de archivos no tiene 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. - 'abortado': la operación se canceló, generalmente debido a un problema de concurrencia, como cancelaciones de transacciones, 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 ves 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}`;

FunctionsErrorCodeCore

Cadena de código de error de funciones añadida después del prefijo de producto "funciones/". Consulte FunctionsErrorCode para obtener la 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';

Https Llamable

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