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 pour 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. |
| multiSélection (options) | Créez une entrée à sélection multiple à partir d’une série de valeurs. |
| multiSélection (options) | Créez une entrée à sélection multiple allant de la carte des étiquettes aux valeurs. |
| Sélectionnez les options) | Créez une entrée de sélection à partir d’une série de valeurs. |
| sélectionner (options avec étiquettes) | Créez une entrée de sélection à partir d’une carte d’étiquettes vers des valeurs. |
Des classes
| Classe | Description |
|---|---|
| Expression |
Interfaces
| Interface | Description |
|---|---|
| EntréeSélectionMultiple | Spécifie que la valeur d'un paramètre doit être déterminée en demandant à l'utilisateur de sélectionner un sous-ensemble dans une liste d'options prédéfinies de manière interactive au moment du déploiement. Entraînera des erreurs s’il est utilisé sur des paramètres de type autre que string[] . |
| SélectionnerEntrée | Spécifie que la valeur d'un paramètre doit être déterminée en demandant à l'utilisateur de faire une sélection interactive dans une liste d'options prédéfinies au moment du déploiement. |
| Sélectionnez les options | Une des options fournies à un SelectInput , contenant une valeur et éventuellement une étiquette lisible par l'homme à afficher dans l'interface de sélection. |
| Saisie de texte | Spécifie que la valeur d'un paramètre doit être déterminée en invitant l'utilisateur à la saisir de manière interactive au moment du déploiement. L'entrée qui ne correspond pas au validationRegex fourni, le cas échéant, sera réessayée. |
Variables
| Variable | Description |
|---|---|
| BUCKET_PICKER | Générez automatiquement une liste de compartiments dans un projet parmi lesquels un utilisateur peut sélectionner. |
| 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 du projet Cloud associé au projet, sans inviter le déployeur. |
| seau de stockage | Un paramètre intégré qui résout le compartiment 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ètre. |
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ètre 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ètre 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ètre 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 pour 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ètre 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ètre avec un type de retour string pour .value .
params.multiSelect()
Créez une entrée à sélection multiple à partir d’une série de valeurs.
Signature:
export declare function multiSelect(options: string[]): MultiSelectInput;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| choix | chaîne[] |
Retour:
params.multiSelect()
Créez une entrée à sélection multiple allant de la carte des étiquettes aux valeurs.
Signature:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| choix | Enregistrer<string, string> |
Retour:
params.select()
Créez une entrée de sélection à partir d’une série de valeurs.
Signature:
export declare function select<T>(options: T[]): SelectInput<T>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| choix | T[] |
Retour:
params.select()
Créez une entrée de sélection à partir d’une carte d’étiquettes vers des valeurs.
Signature:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| optionsAvecÉtiquettes | Enregistrer<string, T> |
Retour:
params.BUCKET_PICKER
Générez automatiquement une liste de compartiments dans un projet parmi lesquels un utilisateur peut sélectionner.
Signature:
BUCKET_PICKER: ResourceInput
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 du 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 elle n'est pas 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ètre.
Signature:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;