Esta página foi traduzida pela API Cloud Translation.

params namespace

Funções

Função	Descrição
defineBoolean(name, options)	Declare um parâmetro booleano.
defineInt(nome, opções)	Declarar um parâmetro de número inteiro.
defineList(nome, opções)	Declarar um parâmetro de lista.
defineSecret(name)	Declara um parâmetro secreto que manterá os valores somente no Cloud Secret Manager. Os secrets são armazenados internamente como strings de bytes. Use ParamOptions.`as` para fornecer dicas de tipo durante a resolução de parâmetros.
defineString(name, options)	Declarar um parâmetro de string.

Classes

Turma	Descrição
Expressão

Variáveis

Variável	Descrição
databaseURL (link em inglês)	Um parâmetro integrado que resolve para o URL padrão do banco de dados do RTDB associado ao projeto, sem notificar o implantador. String vazia se nenhuma existir.
declaredParams.
gcloudProject (em inglês)	Um parâmetro integrado que é resolvido para o ID do projeto do Cloud, sem solicitar ao implantador.
ID do projeto	Um parâmetro integrado que se resolve para o ID do projeto do Cloud associado ao projeto, sem enviar uma solicitação ao implantador.
storageBucket	Um parâmetro integrado que é resolvido para o bucket do Cloud Storage associado à função, sem solicitar ao implantador. String vazia se não tiver sido definida.

Aliases de tipos

Alias de tipo	Descrição
ParamOptions (em inglês)	Opções de configuração que podem ser usadas para personalizar o comportamento de comandos 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
name	string	O nome da variável de ambiente a ser usada para carregar o parâmetro.
options	ParamOptions<boolean>	Opções de configuração do parâmetro.

Retorna:

Parâmetro booleano

Um parâmetro com um tipo de retorno boolean para .value.

params.defineInt()

Declarar um parâmetro de número inteiro.

Assinatura:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

Parâmetros

Parâmetro	Tipo	Descrição
name	string	O nome da variável de ambiente a ser usada para carregar o parâmetro.
options	Opções do parâmetro<number>	Opções de configuração do parâmetro.

Retorna:

IntParam

Um parâmetro com um tipo de retorno number para .value.

params.defineList()

Declarar um parâmetro de lista.

Assinatura:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

Parâmetros

Parâmetro	Tipo	Descrição
name	string	O nome da variável de ambiente a ser usada para carregar o parâmetro.
options	Opções de parâmetro<string[]>	Opções de configuração do parâmetro.

Retorna:

Parâmetro de lista

Um parâmetro com um tipo de retorno string[] para .value.

params.defineSecret()

Declara um parâmetro secreto que manterá os valores somente no Cloud Secret Manager. Os secrets são armazenados internamente como strings de bytes. Use ParamOptions.as para fornecer dicas de tipo durante a resolução de parâmetros.

Assinatura:

export declare function defineSecret(name: string): SecretParam;

Parâmetros

Parâmetro	Tipo	Descrição
name	string	O nome da variável de ambiente a ser usada para carregar o parâmetro.

Retorna:

Param secreto

Um parâmetro com um tipo de retorno string para .value.

params.defineString()

Declarar um parâmetro de string.

Assinatura:

export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;

Parâmetros

Parâmetro	Tipo	Descrição
name	string	O nome da variável de ambiente a ser usada para carregar o parâmetro.
options	Opções de parâmetro<string>	Opções de configuração do parâmetro.

Retorna:

Parâmetro String

Um parâmetro com um tipo de retorno string para .value.

params.databaseURL

Um parâmetro integrado que resolve para o URL padrão do banco de dados do RTDB associado ao projeto, sem notificar o implantador. String vazia se nenhuma existir.

Assinatura:

databaseURL: Param<string>

params.declaredParams

Assinatura:

declaredParams: SecretOrExpr[]

parâmetros.gcloudProject

Um parâmetro integrado que é resolvido para o ID do projeto do Cloud, sem solicitar ao implantador.

Assinatura:

gcloudProject: Param<string>

parâmetros.projectID

Um parâmetro integrado que se resolve para o ID do projeto do Cloud associado ao projeto, sem enviar uma solicitação ao implantador.

Assinatura:

projectID: Param<string>

params.storageBucket

Um parâmetro integrado que é resolvido para o bucket do Cloud Storage associado à função, sem solicitar ao implantador. String vazia se não tiver sido definida.

Assinatura:

storageBucket: Param<string>

params.ParamOptions

Opções de configuração que podem ser usadas para personalizar o comportamento de comandos de um parâmetro.

Assinatura:

export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;