Skip to content

Environment

Environment variable management and .env file loading.

3 modules

ModuleDescription
Obter Variável de AmbienteObter o valor de uma variável de ambiente
Carregar Arquivo .envCarregar variáveis de ambiente de um arquivo .env
Definir Variável de AmbienteDefinir uma variável de ambiente no processo atual

Modules

Obter Variável de Ambiente

env.get

Obter o valor de uma variável de ambiente

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-Nome da variável de ambiente
defaultstringNo-Valor padrão se a variável não estiver definida

Output:

FieldTypeDescription
namestringNome da variável
valuestringValor da variável (ou padrão se não definido)
existsbooleanSe a variável existe no ambiente

Example: Get HOME variable

yaml
name: HOME

Example: Get variable with default

yaml
name: MY_APP_PORT
default: 8080

Carregar Arquivo .env

env.load_dotenv

Carregar variáveis de ambiente de um arquivo .env

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes.envCaminho para o arquivo .env
overridebooleanNoFalseSe deve sobrescrever variáveis de ambiente existentes

Output:

FieldTypeDescription
loaded_countnumberNúmero de variáveis carregadas
variablesarrayLista de nomes de variáveis que foram carregadas

Example: Load .env file

yaml
path: .env
override: false

Definir Variável de Ambiente

env.set

Definir uma variável de ambiente no processo atual

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-Nome da variável de ambiente a ser definida
valuestringYes-Valor a ser atribuído à variável de ambiente

Output:

FieldTypeDescription
namestringNome da variável
valuestringNovo valor que foi definido
previous_valuestringValor anterior (nulo se não definido anteriormente)

Example: Set an environment variable

yaml
name: MY_APP_PORT
value: 3000

Released under the Apache 2.0 License.