params namespace

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. Use ParamOptions.as para fornecer dicas de tipo durante a resolução de parâmetros.
defineString(nome, opções) Declare um parâmetro de string.
seleção múltipla (opções) Crie uma entrada de seleção múltipla a partir de uma série de valores.
seleção múltipla (opções) Crie uma entrada de seleção múltipla do mapa de rótulos para valores.
Selecione as opções) Crie uma entrada selecionada a partir de uma série de valores.
selecione(opçõesComLabels) Crie uma entrada selecionada a partir de um mapa de rótulos para valores.

Aulas

Aula Descrição
Expressão

Interfaces

Interface Descrição
MultiSelectInput Especifica que o valor de um parâmetro deve ser determinado fazendo com que o usuário selecione um subconjunto de uma lista de opções predefinidas de forma interativa no momento da implantação. Resultará em erros se usado em parâmetros de tipo diferente de string[] .
SelecioneInput Especifica que o valor de um parâmetro deve ser determinado fazendo com que o usuário selecione interativamente em uma lista de opções predefinidas no momento da implantação.
Selecione as opções Uma das opções fornecidas para SelectInput , contendo um valor e opcionalmente um rótulo legível para exibição na interface de seleção.
Entrada de texto Especifica que o valor de um parâmetro deve ser determinado solicitando que o usuário o digite interativamente no momento da implantação. A entrada que não corresponder ao validaçãoRegex fornecido, se presente, será tentada novamente.

Variáveis

Variável Descrição
BUCKET_PICKER Gere automaticamente uma lista de buckets em um projeto que um usuário pode selecionar.
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 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 ParamOpções <booleano> Opções de configuração para o parâmetro.

Retorna:

BooleanParam

Um parâmetro 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 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 ParamOpções <string[]> Opções de configuração para o parâmetro.

Retorna:

ListaParam

Um parâmetro 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. 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
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 ParamOpções <string> Opções de configuração para o parâmetro.

Retorna:

StringParam

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

params.multiSelect()

Crie uma entrada de seleção múltipla a partir de uma série de valores.

Assinatura:

export declare function multiSelect(options: string[]): MultiSelectInput;

Parâmetros

Parâmetro Tipo Descrição
opções corda[]

Retorna:

MultiSelectInput

params.multiSelect()

Crie uma entrada de seleção múltipla do mapa de rótulos para valores.

Assinatura:

export declare function multiSelect(options: Record<string, string>): MultiSelectInput;

Parâmetros

Parâmetro Tipo Descrição
opções Registro<string, string>

Retorna:

MultiSelectInput

params.select()

Crie uma entrada selecionada a partir de uma série de valores.

Assinatura:

export declare function select<T>(options: T[]): SelectInput<T>;

Parâmetros

Parâmetro Tipo Descrição
opções T[]

Retorna:

SelecioneInput <T>

params.select()

Crie uma entrada selecionada a partir de um mapa de rótulos para valores.

Assinatura:

export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;

Parâmetros

Parâmetro Tipo Descrição
opçõesWithLabels Registro<string, T>

Retorna:

SelecioneInput <T>

params.BUCKET_PICKER

Gere automaticamente uma lista de buckets em um projeto que um usuário pode selecionar.

Assinatura:

BUCKET_PICKER: ResourceInput

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 solicitação de um parâmetro.

Assinatura:

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