Funciones
| Función | Descripción |
|---|---|
| defineBoolean(nombre, opciones) | Declarar un parámetro booleano. |
| defineInt(nombre, opciones) | Declarar un parámetro entero. |
| defineList(nombre, opciones) | Declarar un parámetro de lista. |
| definirSecreto(nombre) | Declara un parámetro secreto, que conservará los valores solo en Cloud Secret Manager. Los secretos se almacenan internamente como cadenas de bytes. Utilice ParamOptions. as para proporcionar sugerencias de tipo durante la resolución de parámetros. |
| defineString(nombre, opciones) | Declarar un parámetro de cadena. |
Clases
| Clase | Descripción |
|---|---|
| Expresión |
Variables
| Variable | Descripción |
|---|---|
| URL de la 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 preguntar 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 de la nube, sin preguntar al implementador. |
| Projecto ID | Un parámetro integrado que se resuelve en el ID del proyecto en la nube asociado con el proyecto, sin preguntar al implementador. |
| cubo de almacenamiento | Un parámetro integrado que se resuelve en el depósito de almacenamiento en la nube asociado con la función, sin preguntar al implementador. Cadena vacía si no está definida. |
Tipo de alias
| Alias de tipo | Descripción |
|---|---|
| ParamOptions | Opciones de configuración que se pueden usar para personalizar el comportamiento de solicitud de un Param. |
params.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 usará para cargar el parámetro. |
| opciones | ParamOptions <booleano> | Opciones de configuración para el param. |
Devoluciones:
BooleanParam
Un Param con un tipo de retorno boolean para .value .
params.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 usará para cargar el parámetro. |
| opciones | ParamOptions <número> | Opciones de configuración para el param. |
Devoluciones:
IntParam
Un Param con un tipo de devolución number para .value .
params.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 usará para cargar el parámetro. |
| opciones | ParamOptions <cadena[]> | Opciones de configuración para el param. |
Devoluciones:
ListParam
Un Param con un tipo de retorno string[] para .value .
params.defineSecret()
Declara un parámetro secreto, que conservará los valores solo en Cloud Secret Manager. Los secretos se almacenan internamente como cadenas de bytes. Utilice 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 | cadena | El nombre de la variable de entorno que se usará para cargar el parámetro. |
Devoluciones:
SecretParam
Un Param con un tipo de retorno string para .value .
params.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 usará para cargar el parámetro. |
| opciones | ParamOptions <cadena> | Opciones de configuración para el param. |
Devoluciones:
StringParam
Un Param 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 preguntar al implementador. Cadena 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 la nube, sin preguntar al implementador.
Firma:
gcloudProject: Param<string>
params.projectID
Un parámetro integrado que se resuelve en el ID del proyecto en la nube asociado con el proyecto, sin preguntar 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 preguntar al implementador. Cadena vacía si no está definida.
Firma:
storageBucket: Param<string>
params.ParamOptions
Opciones de configuración que se pueden usar para personalizar el comportamiento de solicitud de un Param.
Firma:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;