Giter VIP home page Giter VIP logo

env-helpers's Introduction

Env Helpers

npm version

Functions to to help retrieving values from process.env.

Install

npm install --save env-helpers
yarn add env-helpers
pnpm add env-helpers 

Functions

The functions are as follows:

envStr

Types

function envStr(key: string, defaultValue: string): string;
function envStr(key: string, defaultValue?: string): string | undefined;

Usage

envStr('FOO'): string | undefined
envStr('FOO', 'Fallback'): string

envInt

Types

function envInt(key: string, defaultValue: number, radix?: number = 10): number;
function envInt(key: string, defaultValue?: number, radix?: number = 10): number | undefined;

Usage

envInt('FOO'): number | undefined
envInt('FOO', 10, 16): number

envBoolean

Types

function envBool(key: string, defaultValue?: boolean): // boolean;

Usage

envBoolean('FOO'): boolean
envBoolean('FOO', false): boolean

envList

Types

function envList(key: string, defaultValue: string[]): string[];
function envList(key: string, defaultValue?: string[]): string[] | [];

Usage

envList('FOO'): string[] | []
envList('FOO', ['a','b','c']): string[]

envJSON

Types

function envJSON<T extends object>(key: string, defaultValue: T): T;
function envJSON<T extends object>(key: string, defaultValue?: T): T | undefined;

Usage

envJSON<{ [key: string]: string }>('FOO'): { [key: string]: string } | undefined
envJSON<{ biz: string }>('FOO', { biz: 'baz' }): { biz: string }

env-helpers's People

Contributors

thatsourjake avatar

Watchers

 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.