# alinex-config > Loading configuration files from different formats asynchronous with possible checks. Latest version **1.4.2** (published 2017-03-27) · Apache-2.0 license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install alinex-config pnpm add alinex-config yarn add alinex-config bun add alinex-config ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.4.2 | | Published | 2017-03-27 | | First published | 2014-07-11 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.10 | | Dependencies | 9 | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | Alexander Schilling | | Maintainers | alinex | | Keywords | registry, config, configuration, parsing, loading, setup | ## Links - npm: https://www.npmjs.com/package/alinex-config - Repository: https://github.com/alinex/node-config - Homepage: http://alinex.github.io/node-config/ - Issues: https://github.com/alinex/node-config/issues - npm.io page: https://npm.io/package/alinex-config ## Dependencies (9) - [async](https://npm.io/package/async.md) ^2.2.0 - [chalk](https://npm.io/package/chalk.md) ^1.1.3 - [debug](https://npm.io/package/debug.md) ^2.6.3 - [deasync](https://npm.io/package/deasync.md) ^0.1.9 - [request](https://npm.io/package/request.md) ^2.81.0 - [alinex-fs](https://npm.io/package/alinex-fs.md) ^3.0.3 - [alinex-util](https://npm.io/package/alinex-util.md) ^2.5.1 - [alinex-format](https://npm.io/package/alinex-format.md) ^1.1.5 - [alinex-validator](https://npm.io/package/alinex-validator.md) ^2.0.1 ## Alternatives - [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads - [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads - [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads - [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads - [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads ## Recent versions - 1.4.2 (latest) — 2017-03-27 - 1.4.1 — 2016-10-18 - 1.4.0 — 2016-10-17 - 1.3.0 — 2016-10-14 - 1.2.1 — 2016-07-09 - 1.2.0 — 2016-07-09 - 1.1.6 — 2016-06-02 - 1.1.5 — 2016-06-02 - 1.1.4 — 2016-05-17 - 1.1.3 — 2016-05-16 - 1.1.2 — 2016-05-02 - 1.1.1 — 2016-04-29 - 1.1.0 — 2016-04-21 - 1.0.19 — 2016-04-15 - 1.0.18 — 2016-04-11 - … 31 more at https://npm.io/package/alinex-config/versions ## README Alinex Config: Readme ================================================= [![GitHub watchers]( https://img.shields.io/github/watchers/alinex/node-config.svg?style=social&label=Watch&maxAge=2592000)]( https://github.com/alinex/node-config/subscription) [![GitHub stars]( https://img.shields.io/github/stars/alinex/node-config.svg?style=social&label=Star&maxAge=2592000)]( https://github.com/alinex/node-config) [![GitHub forks]( https://img.shields.io/github/forks/alinex/node-config.svg?style=social&label=Fork&maxAge=2592000)]( https://github.com/alinex/node-config) [![npm package]( https://img.shields.io/npm/v/alinex-config.svg?maxAge=2592000&label=latest%20version)]( https://www.npmjs.com/package/alinex-config) [![latest version]( https://img.shields.io/npm/l/alinex-config.svg?maxAge=2592000)]( #license) [![Travis status]( https://img.shields.io/travis/alinex/node-config.svg?maxAge=2592000&label=develop)]( https://travis-ci.org/alinex/node-config) [![Coveralls status]( https://img.shields.io/coveralls/alinex/node-config.svg?maxAge=2592000)]( https://coveralls.io/r/alinex/node-config?branch=master) [![Gemnasium status]( https://img.shields.io/gemnasium/alinex/node-config.svg?maxAge=2592000)]( https://gemnasium.com/alinex/node-config) [![GitHub issues]( https://img.shields.io/github/issues/alinex/node-config.svg?maxAge=2592000)]( https://github.com/alinex/node-config/issues) This package will give you an easy way to load and use configuration settings in your application or module. It will read named files in different formats (YAML, JSON, XML, JavaScript, CoffeeScript) and supports validation and optimization/completion. Also the configuration will automatically be updated on changes in the file system and may inform it's dependent objects. The major features are: - over writable configurations - allows different file formats - supports value validation - supports value modification rules - automatically reloads on file changes > It is one of the modules of the [Alinex Namespace](https://alinex.github.io/code.html) > following the code standards defined in the [General Docs](https://alinex.github.io/develop). __Read the complete documentation under [https://alinex.github.io/node-config](https://alinex.github.io/node-config).__ Install ------------------------------------------------- [![NPM](https://nodei.co/npm/alinex-config.png?downloads=true&downloadRank=true&stars=true) ![Downloads](https://nodei.co/npm-dl/alinex-config.png?months=9&height=3) ](https://www.npmjs.com/package/alinex-config) The easiest way is to let npm add the module directly to your modules (from within you node modules directory): ``` sh npm install alinex-config --save ``` And update it to the latest version later: ``` sh npm update alinex-config --save ``` Always have a look at the latest [changes](Changelog.md). Sources / File Formats ------------------------------------------------- This configuration class allows multiple formats to be used alternatively or combined. So you may use the format you know best. See the {@link alinex-format/src/type/index.md alinex-format} package for a detailed description of the allowed formats and description of how to write them. As described in the link above you can use different formats but you can also split your configuration into multiple files and use different formats in each of them. So as an first example if you have a very large configuration of three major parts you may split it up into 3 different files. ``` yaml # config/server/http.yml listen: ip: 192.168.0.1 port: 80 ``` ``` yaml # config/server/ftp.yml listen: ip: 192.168.0.1 port: 21 ``` ``` yaml # config/server/mail.yml pop: port: 110 imap: port: 143 ``` And if the program now reads `config/**` you will get the combined structure: ``` yaml server: http: listen: ip: 192.168.0.1 port: 80 ftp: listen: ip: 192.168.0.1 port: 21 mail: pop: port: 110 imap: port: 143 ``` This is because the config system will use the names behind the asterisk as structure levels automatically but you may control the combination rules using filter and path in the origin setup (see below). Usage ------------------------------------------------- To use the configuration management you have to load the module first: ``` coffee config = require 'alinex-config' ``` This gives you back the main configuration instance. But before you can access your configuration you have to setup the system if not already done and initialize it: ``` coffee # register common configuration paths for application config.register 'myapp', __dirname # add a special path on the end (highest priority) config.pushOrigin uri: 'file:///etc/my-config.yml' # and add a schema to verify the database settings are correct config.setSchema 'database', type: .... # schema # start initializing the configuration and load the data config.init (err) -> return cb err if err # all configurations are loaded successfully ``` Alternatively you may skip your program with a detailed error message: ``` coffee config.init (err) -> if err console.error "FAILED: #{err.message}" console.error err.description process.exit 1 ``` Make sure that the initialization is completely done for all configuration data before using it. If you change the setup later you have to reinit everything which causes an extra afford which you should skip if possible. After that is done you can easily access the configuration like: ``` coffee conf = config.data # here you have the whole registry data conf = config.get 'server' # and now you have only the server structure conf = config.get 'database/master/address' # or only a specific database connection ``` > To don't mess with the names: I always address the instance with `config` and use > a short name like `conf` for some data out of it. On demand you may also reload the configuration completely: ``` coffee config.reload (err) -> if err console.error "FAILED: #{err.message}" console.error err.description process.exit 1 ``` But if you want tp know in your app then some configuration was changed you can use the path as an event which is fired if this element or one below is changed. ``` coffee config.on '/address', -> console.log "New addresses found, reinit the list..." myList = config.get '/address' ``` Debugging ------------------------------------------------- If you have any problems you may debug the code with the predefined flags. It uses the debug module to let you define what to debug. Call it with the DEBUG environment variable set to - 'config' for basic information - 'config:value' with structure after loaded - 'config:access' with info about data accessed - 'config*' for all of them You can also combine them using comma or use only DEBUG=* to show all debug messages of all modules. Additional value checking will be done if the debugging for the general `config` is enabled. License ------------------------------------------------- (C) Copyright 2014-2016 Alexander Schilling Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at > Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --- _Source: https://npm.io/package/alinex-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._