Giter VIP home page Giter VIP logo

store-env's Introduction

store-env CI

Store for environment variables

Install

$ npm install store-env

Usage

const {env} = require('store-env')

process.env.URL = 'https://www.google.com/';
process.env.DATABASE = 'SOME_VERY_LONG_NAME';
process.env.COUNTER = 5;

const envStore = env(
		process.env, // {URL: string; DATABASE: string; name: string}
		{
			defaults: {NAME: 'FooBar', DATABASE: 'FOO'},
			validators: {DATABASE: user => user.length < 3, COUNTER: counter => counter % 5 !== 0}
		}
	);

// Available in environment and no validation defined
envStore.get('URL') // 'https://www.google.com/'

// Failed the validation function but a default `FOO` is provided
envStore.get('DATABASE') // 'FOO'

// Default `FooBar` is provided
envStore.get('NAME') // 'FooBar'

// Failed the validation
envStore.get('COUNTER') // undefined

API

envStore(environment, options?)

environment

Type: Object

Environment object

[options]

Type: Object

[options.defaults]

Type: Object

Default fallbacks for when the environment variable is undefined or fails validation

[options.validators]

Type: Object

Assertion functions, returning a boolean to reflect the validation of the environment variable

store-env's People

Contributors

simonjang avatar

Stargazers

Roman avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.