envix

envix ⚙️

This library simplifies reading, transforming, and requiring environment variables across runtimes like Node.js, Deno, Bun.js, Browser, and more.

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

npm install envix --save

Usage

Set

import { set } from 'envix';

set('foo', 'bar');

Read

import { read, set } from 'envix';

set('foo', 'bar');

read('foo'); // string | undefined
// bar

read('bar', 'baz'); // string
// baz

Read Array

import { readArray, set } from 'envix';

set('foo', 'bar,baz');

readArray('foo'); // string[] | undefined
// ['bar', 'baz']

Read Bool

import { readBool, set } from 'envix';

set('foo', 'true');

readBool('foo'); // boolean | undefined
// true

Read Number

import { readNumber, set } from 'envix';

set('foo', '1.0');

readNumber('foo'); // number | undefined
// 1.0

Read Number Array

import { readNumberArray, set } from 'envix';

set('foo', '1.0,2.1');

readNumberArray('foo'); // number[] | undefined
// [1.0,2.1]

Contributing

Before starting to work on a pull request, it is important to review the guidelines for contributing and the code of conduct. These guidelines will help to ensure that contributions are made effectively and are accepted.

License

Made with 💚

Published under MIT License.

Changelog

1.0.0 (2024-02-08)

Features

• initialized project (b59cb2a)