environmentality

environmentality

Makes you have a good time with environment variables and dotenv
View on npm »

View on github · Report Bug · Request Feature · Issues

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Installation
• Usage
  • Environment variables
  • Code
• Roadmap
• Contributing
• License

About The Project

This package lets you easily manage your environment variables and dotenv files. It is designed to be as simple as possible to use and to be as flexible as possible.

When an environement variable is missing, it will throw an error or use a default value. It also can be used to convert environment variables to other types like numbers or booleans.

It may be used with dotenv and dotenv-expand but can also be used without them.

Built With

• 
• 

Getting Started

Installation

npm install environmentality

Usage

Environment variables

TEST_STRING=Hello World
TEST_NUMBER=42
TEST_BOOLEAN=true
TEST_ENUM=test

Code

import { Env, EnvVar } from 'environmentality'

@Env()
class Env {

  @EnvVar()
  readonly TEST_STRING?: string

  @EnvVar({ type: "number" })
  readonly TEST_NUMBER?: number

  @EnvVar({ type: "boolean", name: "TEST_BOOLEAN" })
  readonly myBool?: boolean

  @EnvVar({ type: "enum", enumValues: ["test", "lmao"] })
  readonly TEST_ENUM?: "test" | "lmao"

}

const env = new Env()

console.log(env.TEST_STRING) // Hello World

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.