Funções
| Função | Descrição |
|---|---|
| defineBoolean(nome, opções) | Declare um parâmetro booleano. |
| defineInt(nome, opções) | Declare um parâmetro inteiro. |
| defineList(nome, opções) | Declare um parâmetro de lista. |
| defineSegredo(nome) | Declara um parâmetro secreto, que persistirá valores apenas no Cloud Secret Manager. Os segredos são armazenados internamente como bytestrings. Utilize ParamOptions. as fornecer dicas de tipo durante a resolução do parâmetro. |
| defineString(nome, opções) | Declare um parâmetro de string. |
Aulas
| Aula | Descrição |
|---|---|
| Expressão |
Variáveis
| Variável | Descrição |
|---|---|
| URL do banco de dados | Um parâmetro integrado que resolve a URL do banco de dados RTDB padrão associada ao projeto, sem avisar o implementador. String vazia se não existir nenhuma. |
| declaradoParams | |
| gcloudProject | Um parâmetro integrado que resolve o ID do projeto do Cloud, sem avisar o implementador. |
| ID do projeto | Um parâmetro integrado que resolve o ID do projeto do Cloud associado ao projeto, sem avisar o implementador. |
| armazenamentoBucket | Um parâmetro integrado que resolve o bucket de armazenamento em nuvem associado à função, sem avisar o implementador. String vazia se não estiver definida. |
Aliases de tipo
| Digite Alias | Descrição |
|---|---|
| ParamOpções | Opções de configuração que podem ser usadas para personalizar o comportamento de prompt de um Param. |
params.defineBoolean()
Declare um parâmetro booleano.
Assinatura:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| nome | corda | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
| opções | ParamOpções <booleano> | Opções de configuração para o parâmetro. |
Retorna:
BooleanParam
Um Param com tipo de retorno boolean para .value .
params.defineInt()
Declare um parâmetro inteiro.
Assinatura:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| nome | corda | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
| opções | ParamOpções <número> | Opções de configuração para o parâmetro. |
Retorna:
IntParam
Um Param com um tipo de retorno number para .value .
params.defineList()
Declare um parâmetro de lista.
Assinatura:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| nome | corda | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
| opções | ParamOpções <string[]> | Opções de configuração para o parâmetro. |
Retorna:
ListaParam
Um Param com um tipo de retorno string[] para .value .
params.defineSecret()
Declara um parâmetro secreto, que persistirá valores apenas no Cloud Secret Manager. Os segredos são armazenados internamente como bytestrings. Utilize ParamOptions. as fornecer dicas de tipo durante a resolução do parâmetro.
Assinatura:
export declare function defineSecret(name: string): SecretParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| nome | corda | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
Retorna:
SecretParam
Um Param com um tipo de retorno string para .value .
params.defineString()
Declare um parâmetro de string.
Assinatura:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| nome | corda | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
| opções | ParamOpções <string> | Opções de configuração para o parâmetro. |
Retorna:
StringParam
Um Param com um tipo de retorno string para .value .
params.databaseURL
Um parâmetro integrado que resolve a URL do banco de dados RTDB padrão associada ao projeto, sem avisar o implementador. String vazia se não existir nenhuma.
Assinatura:
databaseURL: Param<string>
params.declaredParams
Assinatura:
declaredParams: SecretOrExpr[]
params.gcloudProject
Um parâmetro integrado que resolve o ID do projeto do Cloud, sem avisar o implementador.
Assinatura:
gcloudProject: Param<string>
params.projectID
Um parâmetro integrado que resolve o ID do projeto do Cloud associado ao projeto, sem avisar o implementador.
Assinatura:
projectID: Param<string>
params.storageBucket
Um parâmetro integrado que resolve o bucket de armazenamento em nuvem associado à função, sem avisar o implementador. String vazia se não estiver definida.
Assinatura:
storageBucket: Param<string>
params.ParamOptions
Opções de configuração que podem ser usadas para personalizar o comportamento de prompt de um Param.
Assinatura:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;