Skip to content

Latest commit

 

History

History
 
 

config-parser

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
README.md
README.md
 
 
jest.config.js
jest.config.js
 
 
package.json
package.json
 
 
rollup.config.js
rollup.config.js
 
 
tsconfig.json
tsconfig.json
 
 

README.md

@twake/config-parser

Simple module to load a configuration

Synopsis

import twakeConfig from '@twake/config-parser'

const desc = {
  value_1: null,   // configuration key without default value
  value_2: 'val2', // configuration key with default value
}

const optionalConfFile = '/etc/my/conf.json'

const conf = twakeConfig(desc, optionalConfFile)

How it works

twakeConfig() reads optional configuration file if given. Then it parse environment variables to see if key.toUpperCase() exists. If yes, it uses this value for this key, else it uses default value if exists. Then it returns the result.

Copyright and license

Copyright (c) 2023-present Linagora https://linagora.com

License: GNU AFFERO GENERAL PUBLIC LICENSE