Funciones
| Función | Descripción |
|---|---|
| defineBoolean(nombre, opciones) | Declara un parámetro booleano. |
| defineInt(nombre, opciones) | Declara un parámetro de número entero. |
| defineList(nombre, opciones) | Declara un parámetro de lista. |
| defineSecret(nombre) | Declara un parámetro secreto, que conservará valores solo en Cloud Secret Manager. Los secretos se almacenan internamente como strings de bytes. Usa ParamOptions.as para proporcionar sugerencias de tipo durante la resolución de parámetros. |
| defineString(nombre, opciones) | Declara un parámetro de cadena. |
Clases
| Clase | Descripción |
|---|---|
| Expresión |
Variables
| Variable | Descripción |
|---|---|
| URLdebase_de_datos | Un parámetro integrado que se resuelve en la URL de base de datos RTDB predeterminada asociada con el proyecto, sin pedirle al implementador. La cadena está vacía si no existe ninguna. |
| DeclaredParams | |
| gcloudProject | Un parámetro integrado que se resuelve en el ID del proyecto de Cloud, sin solicitar al implementador. |
| ID del proyecto | Un parámetro integrado que se resuelve en el ID del proyecto de Cloud asociado con el proyecto, sin preguntar al implementador. |
| storageBucket | Un parámetro integrado que se resuelve en el bucket de Cloud Storage asociado con la función, sin pedirle permiso al implementador. La cadena está vacía si no se define. |
Escribe alias
| Alias de tipo | Descripción |
|---|---|
| Opciones de parámetros | Son las opciones de configuración que se pueden usar para personalizar el comportamiento de los mensajes de un parámetro. |
params.defineBoolean()
Declara un parámetro booleano.
Firma:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | string | El nombre de la variable de entorno que se usará para cargar el parámetro. |
| opciones | Opciones param.<booleano> | Opciones de configuración para el parámetro. |
Muestra:
BooleanParam
Un parámetro con un tipo de datos que se muestra boolean para .value.
params.defineInt().
Declara un parámetro de número entero.
Firma:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | string | El nombre de la variable de entorno que se usará para cargar el parámetro. |
| opciones | Opciones de parámetros<number> | Opciones de configuración para el parámetro. |
Muestra:
Parámetro interno
Un parámetro con un tipo de datos que se muestra number para .value.
params.defineList()
Declara un parámetro de lista.
Firma:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | string | El nombre de la variable de entorno que se usará para cargar el parámetro. |
| opciones | Opciones<string[]> | Opciones de configuración para el parámetro. |
Muestra:
Parámetro de lista
Un parámetro con un tipo de datos que se muestra string[] para .value.
params.defineSecret()
Declara un parámetro secreto, que conservará valores solo en Cloud Secret Manager. Los secretos se almacenan internamente como strings de bytes. Usa ParamOptions.as para 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 | string | El nombre de la variable de entorno que se usará para cargar el parámetro. |
Muestra:
Parámetro Secret
Un parámetro con un tipo de datos que se muestra string para .value.
params.defineString()
Declara un parámetro de cadena.
Firma:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | string | El nombre de la variable de entorno que se usará para cargar el parámetro. |
| opciones | ParamOptions<string> | Opciones de configuración para el parámetro. |
Muestra:
Parámetro de cadena
Un parámetro con un tipo de datos que se muestra string para .value.
params.databaseURL
Un parámetro integrado que se resuelve en la URL de base de datos RTDB predeterminada asociada con el proyecto, sin pedirle al implementador. La cadena está vacía si no existe ninguna.
Firma:
databaseURL: Param<string>
params.DeclaredParams
Firma:
declaredParams: SecretOrExpr[]
params.gcloudProject
Un parámetro integrado que se resuelve en el ID del proyecto de Cloud, sin solicitar al implementador.
Firma:
gcloudProject: Param<string>
params.projectID
Un parámetro integrado que se resuelve en el ID del proyecto de Cloud asociado con el proyecto, sin preguntar al implementador.
Firma:
projectID: Param<string>
params.storageBucket
Un parámetro integrado que se resuelve en el bucket de Cloud Storage asociado con la función, sin pedirle permiso al implementador. La cadena está vacía si no se define.
Firma:
storageBucket: Param<string>
params.ParamOptions
Son las opciones de configuración que se pueden usar para personalizar el comportamiento de los mensajes de un parámetro.
Firma:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;