A tiny and tree-shakable TypeScript library to get environment variables with type-safe and fallback value for development and production.
npm install @alwatr/envA tiny and tree-shakable TypeScript library to get environment variables with type-safe and fallback value for development and production.
``bash`
npm install @alwatr/env
`typescript
import {getEnv} from '@alwatr/env';
const env = getEnv({
name: 'MY_ENV_VAR',
defaultValue: 'default-value',
developmentValue: 'development-value',
});
console.log(env); // Output: 'development-value' in development mode, 'default-value' if MY_ENV_VAR is not set in production mode.
`
Retrieves the value of an environment variable.
Parameters:
- option: An object with the following properties:name
- : The name of the environment variable.defaultValue
- : The default value to use if the environment variable is not set.developmentValue
- : The value to use in a development environment.
Returns:
The value of the environment variable.
Throws:
An error if the environment variable is not set and no default value is provided.
Basic usage:
`typescript`
const dbUrl = getEnv({name: 'DATABASE_URL', defaultValue: 'mongodb://localhost:27017'});
Development value:
`typescript`
const apiUrl = getEnv({
name: 'API_URL',
defaultValue: 'https://api.example.com',
developmentValue: 'http://localhost:3000',
});
Required environment variable:
`typescript``
const apiKey = getEnv({name: 'API_KEY'}); // Throws an error if API_KEY is not set
The following companies, organizations, and individuals support Nanolib ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
Contributions are welcome! Please read our contribution guidelines before submitting a pull request.