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. |
defineSecret(nome) | Declara um parâmetro secreto, que manterá os valores apenas no Cloud Secret Manager. Os segredos são armazenados internamente como bytestrings. Use 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 para a URL do banco de dados RTDB padrão associada ao projeto, sem avisar o implantador. String vazia se não existir. |
parâmetros declarados | |
gcloudProject | Um parâmetro interno que resolve para o ID do projeto Cloud, sem avisar o implantador. |
ID do projeto | Um parâmetro interno que resolve para o ID do projeto Cloud associado ao projeto, sem avisar o implantador. |
armazenamentoBalde | Um parâmetro interno que resolve para o depósito de armazenamento em nuvem associado à função, sem avisar o implementador. String vazia se não for definida. |
Aliases de tipo
Digite Alias | Descrição |
---|---|
ParamOptions | Opções de configuração que podem ser usadas para personalizar o comportamento de solicitação de um parâmetro. |
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 | ParamOptions <booleano> | Opções de configuração para o parâmetro. |
Retorna:
BooleanParam
Um parâmetro com um 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 | ParamOptions <número> | Opções de configuração para o parâmetro. |
Retorna:
IntParam
Um parâmetro 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 | ParamOptions <string[]> | Opções de configuração para o parâmetro. |
Retorna:
ListParam
Um parâmetro com um tipo de retorno string[]
para .value
.
params.defineSecret()
Declara um parâmetro secreto, que manterá os valores apenas no Cloud Secret Manager. Os segredos são armazenados internamente como bytestrings. Use 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 parâmetro 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 | ParamOptions <string> | Opções de configuração para o parâmetro. |
Retorna:
StringParam
Um parâmetro com um tipo de retorno string
para .value
.
params.databaseURL
Um parâmetro integrado que resolve para a URL do banco de dados RTDB padrão associada ao projeto, sem avisar o implantador. String vazia se não existir.
Assinatura:
databaseURL: Param<string>
params.declaredParams
Assinatura:
declaredParams: SecretOrExpr[]
params.gcloudProject
Um parâmetro interno que resolve para o ID do projeto Cloud, sem avisar o implantador.
Assinatura:
gcloudProject: Param<string>
params.projectID
Um parâmetro interno que resolve para o ID do projeto Cloud associado ao projeto, sem avisar o implantador.
Assinatura:
projectID: Param<string>
params.storageBucket
Um parâmetro interno que resolve para o depósito de armazenamento em nuvem associado à função, sem avisar o implementador. String vazia se não for definida.
Assinatura:
storageBucket: Param<string>
params.ParamOptions
Opções de configuração que podem ser usadas para personalizar o comportamento de solicitação de um parâmetro.
Assinatura:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;