env-typescript v1.0.12

Badges

Installation

npm i env-typescript

Usage

Global

@LoadEnvironment() // ① load .env file
export class GlobalConfig {
  @Column()
  static MESSAGE: string; // ② load MESSAGE from .env file. if not exist this, exception will be create

  @Column()
  static AGE: number; // ③ Automatic Convert
}

process.env.MESSAGE; // YOUR_DATA
GlobalConfig.MESSAGE; // YOUR_DATA

process.env.AGE; // typeof string
GlobalConfig.AGE; // typeof number

Local

@LoadEnvironment('.env', { local: true }) // ① load .env file in local
export class GlobalConfig {
  @Column()
  static MESSAGE: string; // ② load MESSAGE from .env file. if not exist this, exception will be create
}

process.env.MESSAGE; // undefined
GlobalConfig.MESSAGE; // YOUR_DATA

With default

@LoadEnvironment() // ① load .env file
export class GlobalConfig {
  @Column()
  static MESSAGE: string = 'greeting'; // ② load MESSAGE from .env file. if not exist this, instead of 'greeting' will be use
}

process.env.MESSAGE; // greeting or YOUR_DATA
GlobalConfig.MESSAGE; // greeting or YOUR_DATA

Multiple config with global

@LoadEnvironment('aws.global.env')
export class AWS {
  @Column()
  static REGION: string;
}

@LoadEnvironment('aws.s3.env')
export class S3 {
  @Column()
  static BUCKET_NAME: string;
}

process.env.REGION;
AWS.REGION;
process.env.S3
S3.BUCKET_NAME;

Multiple config with global, local

@LoadEnvironment('aws.global.env')
export class AWS {
  @Column()
  static REGION: string;
}

@LoadEnvironment('aws.s3.korea.env', { local: true })
export class S3_KOREA {
  @Column()
  static BUCKET_NAME: string;
}

@LoadEnvironment('aws.s3.japan.env', { local: true })
export class S3_JAPAN {
  @Column()
  static BUCKET_NAME: string;
}

process.env.REGION;
AWS.REGION;
S3_KOREA.BUCKET_NAME;
S3_JAPAN.BUCKET_NAME;

Configuration & Setup

git clone git@github.com:rhea-so-lab/env-typescript.git
cd env-typescript
npm i
npm run start:dev
npm run test # or this

Questions

• Issue
• jeonghyeon.rhea@gmail.com

Contributing

Welcome you to join the development of env-typescript.

Also, welcome PR or issue!

License

MIT