https://github.com/alaricode/nestjs-dotenv
NestJS .env package allows you easily use .env file to store your app configs.
https://github.com/alaricode/nestjs-dotenv
Last synced: 3 months ago
JSON representation
NestJS .env package allows you easily use .env file to store your app configs.
- Host: GitHub
- URL: https://github.com/alaricode/nestjs-dotenv
- Owner: AlariCode
- License: mit
- Created: 2019-08-01T08:08:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-11T07:42:25.000Z (almost 4 years ago)
- Last Synced: 2025-03-24T04:04:42.891Z (3 months ago)
- Language: TypeScript
- Homepage: https://alariblog.ru/
- Size: 299 KB
- Stars: 11
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# NestJS .env config Module
**More NestJS libs on [alariblog.ru](https://alariblog.ru)**
[](https://www.npmjs.com/package/nestjs-dotenv)
[](https://www.npmjs.com/package/nestjs-dotenv)
[](https://github.com/AlariCode/nestjs-dotenv/issues)
[](https://github.com/AlariCode/nestjs-dotenv/pulls)
NestJS .env package allows you easily use .env file to store your app configs.
```bash
npm i nestjs-dotenv
```
Then register module in your root app.module
```javascript
import { ConfigModule } from 'nestjs-dotenv';
@Module({
imports: [
// ...
ConfigModule.forRoot(),
],
})
export class AppModule {}
```
It will load `.env` file from your project root. If you need to change it's path just pass it to `forRoot` method like this:
```javascript
ConfigModule.forRoot(myPath);
```
To use ConfigService in any service or controller just inject it with `@ConfigInjection` decorator in the constructor:
```javascript
import { ConfigService } from 'nestjs-dotenv';
constructor(
private readonly configService: ConfigService
) {}
```
## Get env value
To get a value from .env file just call `get()` method:
```javascript
this.configService.get('JIRA_TOKEN');
```
- JIRA_TOKEN - name of your key in `.env` file:
```
JIRA_TOKEN=0000000000000
```
Method returns `string`.
## Get env value and convert it to specific type
Instead of `get()` method use `getWithType()`:
```javascript
this.configService.getWithType('JIRA_TOKEN', 'string');
```
`getWithType()` get 3 parameters:
- name of your key in `.env` file.
- type of your data in `.env` file.
- (optional) Enum to convert data to, if your type is 'enum'.
Available types:
```bash
// 'number'
VALUE=1
// 'string'
VALUE=mystring
// 'boolean'
VALUE=true
// 'array'
VALUE=[1,2,3]
// 'object'
VALUE={"key": "value"}
/** 'enum'
enum Color {
White = 1
Black = 2
} **/
VALUE=White
```
## Reloading file
To reload env dynamically use `reload()` method:
```javascript
this.configService.reload();
```