@alwatr/env
Advanced tools
A tiny and tree-shakable TypeScript library to get environment variables with type-safe and fallback value for development and production.
A tiny and tree-shakable TypeScript library to get environment variables with type-safe and fallback value for development and production.
npm install @alwatr/env
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.
getEnv(option: GetEnvValueOption): stringRetrieves 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:
const dbUrl = getEnv({name: 'DATABASE_URL', defaultValue: 'mongodb://localhost:27017'});
Development value:
const apiUrl = getEnv({
name: 'API_URL',
defaultValue: 'https://api.example.com',
developmentValue: 'http://localhost:3000',
});
Required environment variable:
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.
This project is licensed under the AGPL-3.0 License.
5.0.0 (2024-11-02)
optionalCo-authored-by: Ali Mihandoost ali@mihandoost.com
get-env-value package (b2a89e1) by @http-utils package (8fd5e78) by @resolve-url package (a884212) by @package-tracer (f570030) by @definePackage to use deduplicate for backward compatibility (990b994) by @@alwatr/util (4cc22ed) by @weaver configs(--preset=weaver) (1bae458) by @__package_name__ (d071d0b) by @global-this (97aa2d0) by @nanolib package to export the common packages (1610b1e) by @http-utils (ab816d2) by @node packages from their files (e039a2f) by @resolve-url from nanolib package (ea40407) by @dedupe package (10c5ffc) by @get-env-package (0e9e492) by @@alwatr/math (f5e32d0) by @render-state package (7f5b112) by @unicode-digits package (2ee138e) by @packageTracer (425e3f9) by @package-tracer (cc3c5f9) by @import & use __package_name__ (1ebbe92) by @demo based on new API (650f159) by @microservice preset (e5e4826) by @mangleProps temporary (65d95cc) by @unicode-digits & update its deps (28a6a65) by @preset option of nano-build to module3 (2d49433) by @exports key for new files (0e9f4aa) by @prototype to check exactly (15dfb6e) by @README (ea2513a) by @interface to type (c9e6970) by @global-this package & remove global type (63f5a3b) by @global-this package & remove global type & prevent sidee-ffects (092d448) by @dedupe anymore (e6c3ce9) by @global-this & update exports key in package.json (42c8081) by @functions & improve the code style (207af08) by @global-this package (42510b9) by @eslint-plugin-require-extensions to peerDependencies (77d0468) by @include: scope from commit-message configuration (8786590) by @imports & test the result of build (7ba474f) by @FAQs
A tiny and tree-shakable TypeScript library to get environment variables with type-safe and fallback value for development and production.
The npm package @alwatr/env receives a total of 66 weekly downloads. As such, @alwatr/env popularity was classified as not popular.
We found that @alwatr/env demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.