opex-env v1.0.4

opex-env

Библиотека для работы с переменными окружения в Node.js.

Установка

npm install opex-env

Тесты

npm run test

Использование

ES Modules (импорт)

import { 
		getEnvPath, 
		envToJson, 
		jsonToEnv, 
		readEnvFile, 
		readEnvProcess, 
		writeEnvFile, 
		writeEnvProcess, 
		mergeEnvData, 
		syncProcFileEnv, 
		updateEnvVar, 
		getEnvVar, 
		deleteEnvVar,
		deleteAllEnv
} from 'opex-env';

CommonJS (require)

const { 
		getEnvPath, 
		envToJson, 
		jsonToEnv, 
		readEnvFile, 
		readEnvProcess, 
		writeEnvFile, 
		writeEnvProcess, 
		mergeEnvData, 
		syncProcFileEnv, 
		updateEnvVar, 
		getEnvVar, 
		deleteEnvVar 
} = require('opex-env');

API

getEnvPath()

Возвращает путь к файлу .env в текущей рабочей директории.

Возвращает: string - Полный путь к файлу .env.

envToJson(envContent, stringify = false)

Преобразует содержимое файла .env в объект JavaScript или строку JSON.

Параметры:

• envContent (string): Содержимое файла .env.
• stringify (boolean, по умолчанию false): Если true, возвращает строку JSON.

Возвращает: object | string - Объект с переменными окружения или строка JSON.

jsonToEnv(jsonContent)

Преобразует объект JavaScript или строку JSON в формат файла .env.

Параметры:

• jsonContent (object | string): Объект или строка JSON с переменными окружения.

Возвращает: string - Строка в формате файла .env.

readEnvFile(envPath, autoCreate = true)

Читает содержимое файла .env.

Параметры:

• envPath (string, необязательный): Путь к файлу .env. Если не указан, используется путь по умолчанию.
• autoCreate (boolean, по умолчанию true): Если true и файл не существует, создает пустой файл .env.

Возвращает: string - Содержимое файла .env.

readEnvProcess()

Возвращает переменные окружения текущего процесса.

Возвращает: object - Объект с переменными окружения процесса.

writeEnvFile(content, envPath)

Записывает содержимое в файл .env.

Параметры:

• content (string): Содержимое для записи в файл .env.
• envPath (string, необязательный): Путь к файлу .env. Если не указан, используется путь по умолчанию.

writeEnvProcess(content)

Обновляет переменные окружения текущего процесса.

Параметры:

• content (object): Объект с переменными окружения для обновления в процессе.

mergeEnvData(envProc, envFile)

Объединяет переменные окружения из процесса и файла .env.

Параметры:

• envProc (object, необязательный): Переменные окружения процесса.
• envFile (object, необязательный): Переменные окружения из файла .env.

Возвращает: object - Объединенный объект с переменными окружения.

syncProcFileEnv()

Синхронизирует переменные окружения между файлом .env и текущим процессом.

updateEnvVar(key, value, envPath)

Обновляет или добавляет переменную окружения в файл .env и процесс.

Параметры:

• key (string): Ключ переменной окружения.
• value (string): Значение переменной окружения.
• envPath (string, необязательный): Путь к файлу .env. Если не указан, используется путь по умолчанию.

getEnvVar(key, fromProcess = false, envPath)

Получает значение переменной окружения из файла .env или процесса.

Параметры:

• key (string): Ключ переменной окружения.
• fromProcess (boolean, по умолчанию false): Если true, читает из процесса, иначе из файла .env.
• envPath (string, необязательный): Путь к файлу .env. Используется только если fromProcess равно false.

Возвращает: string | undefined - Значение переменной окружения или undefined, если переменная не найдена.

deleteEnvVar(key, envPath)

Удаляет переменную окружения из файла .env и процесса.

Параметры:

• key (string): Ключ переменной окружения для удаления.
• envPath (string, необязательный): Путь к файлу .env. Если не указан, используется путь по умолчанию.

deleteAllEnv(envPath)

Удаляет все переменные окружения из файла .env и процесса.

Параметры:

• envPath (string, необязательный): Путь к файлу .env. Если не указан, используется путь по умолчанию.

Примеры использования

import { getEnvVar, updateEnvVar, deleteEnvVar } from 'opex-env';

// Синхронизация файла .env и process.env
syncProcFileEnv();

// Получение значения переменной
const apiKey = getEnvVar('API_KEY');

// Обновление переменной
updateEnvVar('DEBUG', 'true');

// Удаление переменной
deleteEnvVar('TEMP_VAR');

Создатель

OpexDev 13 июля 2024