Installations

npm install @mjsdevs/config.ts

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Node Version

14.15.0

NPM Version

6.14.8 Score

69.9

Supply Chain

79.8

Quality

75.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

4

Total

5

Closed

1

Releases

1

Test release action

v1.3.5

Published on 12 Jun 2021

View all 1 releases

Contributors

3

Unable to fetch Contributors

View all 3 contributors

Languages

1

TypeScript

TypeScript (100%)

Developer

mjsdevs

Download Statistics

Total Downloads

2,933

Last Day

1

Last Week

5

Last Month

7

Last Year

252

GitHub Statistics

1 Stars

69 Commits

1 Watching

1 Branches

3 Contributors

Maintainers

1

Package Meta Information

Latest Version

1.3.6

Package Id

@mjsdevs/config.ts@1.3.6

Unpacked Size

158.56 kB

Size

61.39 kB

File Count

24

NPM Version

6.14.8

Node Version

14.15.0

Total Downloads

Cumulative downloads

Total Downloads

2,933

Last day

0%

1

Compared to previous day

Last week

0%

5

Compared to previous week

Last month

16.7%

7

Compared to previous month

Last year

-57.8%

252

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

dotenv

Dev Dependencies

8

@types/jest @types/node jest nodemon rimraf ts-jest ts-node typescript

Versions

config.ts

Config.ts is a generic configuration service that uses dotenv and typescript to improve the experience when using environment variables.

Install

// with NPM
npm install @mjsdevs/config.ts


// with yarn
yarn add @mjsdevs/config.ts

Usage

1import {
2  Result,
3  ConfigurationServiceFactory,
4} from '@mjsdevs/config.ts'
5
6// create an interface/class with the desired environment variables
7interface EnvDefinition {
8  NODE_ENV: string;
9}
10
11// get a factory for configuration service
12const factory = new ConfigurationServiceFactory<EnvDefinition>();
13
14// use the factory to create a new ConfigurationService instance.
15// you need to implement the handler to return a success or failing Result
16const service = factory.create({
17  validation:{
18    handler: (env) => Result.ok(env),
19  },
20  options: {}
21});
22
23// user the service to get environment variables
24const env = service.get('NODE_ENV'); // development

Changelog

// WIP

Contributing

// WIP

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2024-12-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More