Funzioni
| Funzione | Descrizione |
|---|---|
| defineBoolean(nome, opzioni) | Dichiarare un parametro booleano. |
| defineInt(nome, opzioni) | Dichiarare un parametro intero. |
| defineList(nome, opzioni) | Dichiarare un parametro di lista. |
| defineSecret(nome) | Dichiara un parametro segreto, che manterrà i valori solo in Cloud Secret Manager. I segreti vengono archiviati internamente come stringhe di byte. Usa ParamOptions. as da fornire suggerimenti sul tipo durante la risoluzione dei parametri. |
| defineString(nome, opzioni) | Dichiarare un parametro di stringa. |
Classi
| Classe | Descrizione |
|---|---|
| Espressione |
Variabili
| Variabile | Descrizione |
|---|---|
| URL del database | Un parametro integrato che si risolve nell'URL del database RTDB predefinito associato al progetto, senza richiedere conferma al distributore. Stringa vuota se non esiste. |
| dichiaratoParams | |
| gcloudProject | Un parametro integrato che si risolve nell'ID del progetto cloud, senza richiedere conferma al distributore. |
| IDprogetto | Un parametro integrato che si risolve nell'ID progetto cloud associato al progetto, senza richiedere conferma al distributore. |
| storageBucket | Un parametro integrato che si risolve nel bucket di archiviazione cloud associato alla funzione, senza richiedere conferma al distributore. Stringa vuota se non definita. |
Digitare Alias
| Digita Alias | Descrizione |
|---|---|
| ParamOptions | Opzioni di configurazione che possono essere utilizzate per personalizzare il comportamento di richiesta di un Param. |
params.defineBoolean()
Dichiarare un parametro booleano.
Firma:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| nome | corda | Il nome della variabile di ambiente da utilizzare per caricare il param. |
| opzioni | ParamOptions <booleano> | Opzioni di configurazione per il param. |
Ritorna:
BooleanParam
Un Param con un tipo restituito boolean per .value .
params.defineInt()
Dichiarare un parametro intero.
Firma:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| nome | corda | Il nome della variabile di ambiente da utilizzare per caricare il param. |
| opzioni | ParamOptions <numero> | Opzioni di configurazione per il param. |
Ritorna:
IntParam
Un Param con un tipo restituito number per .value .
params.defineList()
Dichiarare un parametro di lista.
Firma:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| nome | corda | Il nome della variabile di ambiente da utilizzare per caricare il param. |
| opzioni | ParamOptions <string[]> | Opzioni di configurazione per il param. |
Ritorna:
ListParam
Un Param con un tipo restituito string[] per .value .
params.defineSecret()
Dichiara un parametro segreto, che manterrà i valori solo in Cloud Secret Manager. I segreti vengono archiviati internamente come stringhe di byte. Usa ParamOptions. as da fornire suggerimenti sul tipo durante la risoluzione dei parametri.
Firma:
export declare function defineSecret(name: string): SecretParam;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| nome | corda | Il nome della variabile di ambiente da utilizzare per caricare il param. |
Ritorna:
SecretParam
Un Param con un tipo restituito di tipo string per .value .
params.defineString()
Dichiarare un parametro di stringa.
Firma:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| nome | corda | Il nome della variabile di ambiente da utilizzare per caricare il param. |
| opzioni | ParamOptions <stringa> | Opzioni di configurazione per il param. |
Ritorna:
StringParam
Un Param con un tipo restituito di tipo string per .value .
params.databaseURL
Un parametro integrato che si risolve nell'URL del database RTDB predefinito associato al progetto, senza richiedere conferma al distributore. Stringa vuota se non esiste.
Firma:
databaseURL: Param<string>
params.declaredParams
Firma:
declaredParams: SecretOrExpr[]
params.gcloudProject
Un parametro integrato che si risolve nell'ID del progetto cloud, senza richiedere conferma al distributore.
Firma:
gcloudProject: Param<string>
params.IDprogetto
Un parametro integrato che si risolve nell'ID progetto cloud associato al progetto, senza richiedere conferma al distributore.
Firma:
projectID: Param<string>
params.storageBucket
Un parametro integrato che si risolve nel bucket di archiviazione cloud associato alla funzione, senza richiedere conferma al distributore. Stringa vuota se non definita.
Firma:
storageBucket: Param<string>
params.ParamOptions
Opzioni di configurazione che possono essere utilizzate per personalizzare il comportamento di richiesta di un Param.
Firma:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;