Funciones
| Función | Descripción |
|---|---|
| definir booleano (nombre, opciones) | Declarar un parámetro booleano. |
| definirInt(nombre, opciones) | Declarar un parámetro entero. |
| definirLista(nombre, opciones) | Declarar un parámetro de lista. |
| definirSecreto(nombre) | Declara un parámetro secreto que persistirá los valores solo en Cloud Secret Manager. Los secretos se almacenan internamente como cadenas de bytes. Utilice ParamOptions. as proporcionar sugerencias de tipo durante la resolución de parámetros. |
| definirString(nombre, opciones) | Declarar un parámetro de cadena. |
Clases
| Clase | Descripción |
|---|---|
| Expresión |
variables
| Variable | Descripción |
|---|---|
| URL de base de datos | Un parámetro integrado que se resuelve en la URL de la base de datos RTDB predeterminada asociada con el proyecto, sin avisar al implementador. Cadena vacía si no existe ninguna. |
| parámetros declarados | |
| Proyecto gcloud | Un parámetro integrado que se resuelve en el ID del proyecto en la nube, sin avisar al implementador. |
| Projecto ID | Un parámetro integrado que se resuelve en el ID del proyecto de nube asociado con el proyecto, sin avisar al implementador. |
| almacenamientoCubo | Un parámetro integrado que se resuelve en el depósito de almacenamiento en la nube asociado con la función, sin avisar al implementador. Cadena vacía si no está definida. |
Tipo de alias
| Tipo Alias | Descripción |
|---|---|
| OpcionesParam | Opciones de configuración que se pueden utilizar para personalizar el comportamiento de solicitud de un parámetro. |
parámetros.defineBoolean()
Declarar un parámetro booleano.
Firma:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno que se utilizará para cargar el parámetro. |
| opciones | OpcionesParam <booleano> | Opciones de configuración para el parámetro. |
Devoluciones:
parámetro booleano
Un parámetro con un tipo de retorno boolean para .value .
parámetros.defineInt()
Declarar un parámetro entero.
Firma:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno que se utilizará para cargar el parámetro. |
| opciones | OpcionesParam <número> | Opciones de configuración para el parámetro. |
Devoluciones:
IntParam
Un parámetro con un tipo de retorno number para .value .
parámetros.defineList()
Declarar un parámetro de lista.
Firma:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno que se utilizará para cargar el parámetro. |
| opciones | OpcionesParam <cadena[]> | Opciones de configuración para el parámetro. |
Devoluciones:
ListaParam
Un parámetro con un tipo de retorno string[] para .value .
parámetros.defineSecret()
Declara un parámetro secreto que persistirá los valores solo en Cloud Secret Manager. Los secretos se almacenan internamente como cadenas de bytes. Utilice ParamOptions. as proporcionar sugerencias de tipo durante la resolución de parámetros.
Firma:
export declare function defineSecret(name: string): SecretParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno que se utilizará para cargar el parámetro. |
Devoluciones:
parámetro secreto
Un parámetro con un tipo de retorno string para .value .
parámetros.defineString()
Declarar un parámetro de cadena.
Firma:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno que se utilizará para cargar el parámetro. |
| opciones | OpcionesParam <cadena> | Opciones de configuración para el parámetro. |
Devoluciones:
CadenaParam
Un parámetro con un tipo de retorno string para .value .
params.databaseURL
Un parámetro integrado que se resuelve en la URL de la base de datos RTDB predeterminada asociada con el proyecto, sin avisar al implementador. Cadena vacía si no existe ninguna.
Firma:
databaseURL: Param<string>
params.declaredParams
Firma:
declaredParams: SecretOrExpr[]
params.gcloudProyecto
Un parámetro integrado que se resuelve en el ID del proyecto en la nube, sin avisar al implementador.
Firma:
gcloudProject: Param<string>
params.proyectoID
Un parámetro integrado que se resuelve en el ID del proyecto de nube asociado con el proyecto, sin avisar al implementador.
Firma:
projectID: Param<string>
params.storageBucket
Un parámetro integrado que se resuelve en el depósito de almacenamiento en la nube asociado con la función, sin avisar al implementador. Cadena vacía si no está definida.
Firma:
storageBucket: Param<string>
params.ParamOptions
Opciones de configuración que se pueden utilizar para personalizar el comportamiento de solicitud de un parámetro.
Firma:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;