Les fonctions
| Fonction | Description |
|---|---|
| définirBooléen(nom, options) | Déclarez un paramètre booléen. |
| définirInt(nom, options) | Déclarez un paramètre entier. |
| définirListe(nom, options) | Déclarez un paramètre de liste. |
| définirSecret(nom) | Déclare un paramètre secret, qui conservera les valeurs uniquement dans Cloud Secret Manager. Les secrets sont stockés en interne sous forme de chaînes d'octets. Utilisez ParamOptions. as de fournir des indications de type lors de la résolution des paramètres. |
| définirString(nom, options) | Déclarez un paramètre de chaîne. |
Des classes
| Classe | Description |
|---|---|
| Expression |
Variables
| Variable | Description |
|---|---|
| URL de base de données | Un paramètre intégré qui correspond à l'URL de la base de données RTDB par défaut associée au projet, sans inviter le déployeur. Chaîne vide s'il n'en existe pas. |
| Paramètres déclarés | |
| gcloudProjet | Un paramètre intégré qui correspond à l'ID du projet Cloud, sans inviter le déployeur. |
| ID du projet | Un paramètre intégré qui correspond à l'ID de projet Cloud associé au projet, sans inviter le déployeur. |
| seau de stockage | Un paramètre intégré qui résout le bucket de stockage Cloud associé à la fonction, sans inviter le déployeur. Chaîne vide si non définie. |
Tapez les alias
| Tapez l'alias | Description |
|---|---|
| OptionsParam | Options de configuration qui peuvent être utilisées pour personnaliser le comportement d'invite d'un Param. |
params.defineBoolean()
Déclarez un paramètre booléen.
Signature:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| nom | chaîne | Le nom de la variable d'environnement à utiliser pour charger le paramètre. |
| choix | OptionsParam <booléen> | Options de configuration pour le paramètre. |
Retour:
BooleanParam
Un Param avec un type de retour boolean pour .value .
params.defineInt()
Déclarez un paramètre entier.
Signature:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| nom | chaîne | Le nom de la variable d'environnement à utiliser pour charger le paramètre. |
| choix | OptionsParam <numéro> | Options de configuration pour le paramètre. |
Retour:
IntParam
Un Param avec un type de retour number pour .value .
params.defineList()
Déclarez un paramètre de liste.
Signature:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| nom | chaîne | Le nom de la variable d'environnement à utiliser pour charger le paramètre. |
| choix | OptionsParam <chaîne[]> | Options de configuration pour le paramètre. |
Retour:
ListeParam
Un Param avec un type de retour string[] pour .value .
params.defineSecret()
Déclare un paramètre secret, qui conservera les valeurs uniquement dans Cloud Secret Manager. Les secrets sont stockés en interne sous forme de chaînes d'octets. Utilisez ParamOptions. as de fournir des indications de type lors de la résolution des paramètres.
Signature:
export declare function defineSecret(name: string): SecretParam;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| nom | chaîne | Le nom de la variable d'environnement à utiliser pour charger le paramètre. |
Retour:
SecretParam
Un Param avec un type de retour string pour .value .
params.defineString()
Déclarez un paramètre de chaîne.
Signature:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| nom | chaîne | Le nom de la variable d'environnement à utiliser pour charger le paramètre. |
| choix | OptionsParam <chaîne> | Options de configuration pour le paramètre. |
Retour:
StringParam
Un Param avec un type de retour string pour .value .
params.databaseURL
Un paramètre intégré qui correspond à l'URL de la base de données RTDB par défaut associée au projet, sans inviter le déployeur. Chaîne vide s'il n'en existe pas.
Signature:
databaseURL: Param<string>
params.declaredParams
Signature:
declaredParams: SecretOrExpr[]
params.gcloudProject
Un paramètre intégré qui correspond à l'ID du projet Cloud, sans inviter le déployeur.
Signature:
gcloudProject: Param<string>
params.projectID
Un paramètre intégré qui correspond à l'ID de projet Cloud associé au projet, sans inviter le déployeur.
Signature:
projectID: Param<string>
params.storageBucket
Un paramètre intégré qui résout le bucket de stockage Cloud associé à la fonction, sans inviter le déployeur. Chaîne vide si non définie.
Signature:
storageBucket: Param<string>
params.ParamOptions
Options de configuration qui peuvent être utilisées pour personnaliser le comportement d'invite d'un Param.
Signature:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;