functions package

Cloud Functions para Firebase

Funciones

Función Descripción
function(app, ...)
getFunctions(app, regionOrCustomDomain) Muestra una instancia de Functions para la app determinada.
function(functionsInstance, ...)
connectFunctionsEmulator(functionsInstance, host, port) Modifica esta instancia para que se comunique con el emulador de Cloud Functions.Nota: Se debe llamar a esta instancia antes de que se use para realizar operaciones.
httpsCallable(functionsInstance, name, options) Muestra una referencia al activador de HTTPS que admite llamadas con el nombre determinado.
httpsCallableFromURL(functionsInstance, url, options) Muestra una referencia al activador de HTTPS que admite llamadas con la URL especificada.

Interfaces

Interfaz Descripción
Funciones Una instancia de Functions.
FunctionsError Un error que muestra el SDK de cliente de Firebase Functions.
HttpsCallableOptions. Una interfaz para metadatos sobre cómo se deben ejecutar las llamadas.
HttpsCallableResult. Un elemento HttpsCallableResult une un solo resultado de una llamada a función.

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 aquí: https://github.com/grpc/grpc/blob/master/doc/statuscodes.mdValores posibles: - “cancelled”: La operación fue cancelada (por lo general, por el llamador). - “desconocido”: un error desconocido o que proviene de un dominio de errores diferente. - 'invalid-argument': El cliente especificó un argumento no válido. Ten en cuenta que esto es diferente de “con error de condición previa”. "argumento no válido" indica los argumentos que son problemáticos independientemente del estado del sistema (p.ej., un nombre de campo no válido). - "deadline-exceeded": El plazo 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. - 'ya existe': Algún documento que intentamos crear ya existe. - “permission-denied”: El emisor no tiene permiso para ejecutar la operación especificada. - "resource-agotado": 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': la operación se rechazó porque el sistema no se encuentra en un estado necesario para la ejecución de la operación. - “aborted”: la operación se anuló, por lo general debido a un problema de simultaneidad, como la anulación de transacciones, entre otros. - “fuera de rango”: la operación se intentó fuera del rango válido. - "unimplemented": La operación no se ha implementado, 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. - "no disponible": 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”: pérdida o corrupción de datos irrecuperables. - "unauthenticated": La solicitud no tiene credenciales de autenticación válidas para la operación.
FunctionsErrorCodeCore La cadena del código de error de Functions se agrega después de "functions/" el prefijo del producto. Consulta FunctionsErrorCode para ver la documentación completa de los códigos.
HttpsCallable Una referencia a un elemento "que admite llamadas" activador HTTP en Google Cloud Functions.

función(app, ...)

getFunctions(app, regiónOrCustomDomain)

Muestra una instancia de Functions para la app determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
app App de Firebase La FirebaseApp que se usará.
regiónOrCustomDomain string Una de las siguientes opciones: a) La región en la que se encuentran las funciones que admiten llamadas (p. ej., us-central1) b) Un dominio personalizado que aloja las funciones que admiten llamadas (p. ej., https://midominio.com)

Muestra:

Funciones

function(functionsInstance, ...)

connectFunctionsEmulator(functionsInstance, host, port)

Modifica esta instancia para que se comunique 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
Instancia de funciones Funciones
host string El host del emulador (p. ej., localhost)
puerto número El puerto del emulador (p. ej., 5001)

Muestra:

void

httpsCallable(functionsInstance, name, options)

Muestra una referencia al activador de HTTPS que admite llamadas con el nombre determinado.

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
Instancia de funciones Funciones
nombre string El nombre del activador.
opciones HttpsCallableOptions.

Muestra:

HttpsCallable<RequestData, ResponseData>.

httpsCallableFromURL(functionsInstance, url, options)

Muestra una referencia al activador de HTTPS que admite llamadas 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
Instancia de funciones Funciones
url string La URL del activador.
opciones HttpsCallableOptions.

Muestra:

HttpsCallable<RequestData, ResponseData>.

FunctionsErrorCode

Es el conjunto de códigos de estado de Firebase Functions. Los códigos son los mismos que los que expone gRPC aquí: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Valores posibles: - "cancelled": La operación se canceló (por lo general, la cancela el emisor). - “desconocido”: un error desconocido o que proviene de un dominio de errores diferente. - 'invalid-argument': El cliente especificó un argumento no válido. Ten en cuenta que esto es diferente de “con error de condición previa”. "argumento no válido" indica los argumentos que son problemáticos independientemente del estado del sistema (p.ej., un nombre de campo no válido). - "deadline-exceeded": El plazo 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. - 'ya existe': Algún documento que intentamos crear ya existe. - “permission-denied”: El emisor no tiene permiso para ejecutar la operación especificada. - "resource-agotado": 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': la operación se rechazó porque el sistema no se encuentra en un estado necesario para la ejecución de la operación. - “aborted”: la operación se anuló, por lo general debido a un problema de simultaneidad, como la anulación de transacciones, entre otros. - “fuera de rango”: la operación se intentó fuera del rango válido. - "unimplemented": La operación no se ha implementado, 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. - "no disponible": 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”: 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 declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

FunctionsErrorCodeCore

La cadena del código de error de Functions se agrega después de "functions/" el prefijo del producto. Consulta FunctionsErrorCode para ver 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';

HttpsCallable

Una referencia a un elemento "que admite llamadas" activador HTTP en Google Cloud Functions.

Firma:

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