🔧 confhub-node

Node.js/TS wrapper around confhub.
Confhub handles the configuration, confhub-node makes it easy to work with confhub from within a Node.js application. It provides access to config in an intuitive and type-safe way.

Install

1. Download confhub, compile it, and make sure it is in $PATH.
2. Install confhub-node using npm install confhub-node

Use

1. Define configuration structure in Conf.ts:

   export type Conf = {
   	a: string,
   	b: boolean,
   	c: number,
   	d: {
   		something: Array<string>,
   		num: number
   	}
   }

2. Create configuration instance using Conf.ts as declaration (more details on confhub page)
   confhub configure Conf.ts

3. Access configuration from your Node.js application app.ts:

   import { Conf } from "./Conf.js";
   import { Confhub } from 'confhub-node';
   
   // replace confName below with name you've given to your configuration in step 2
   const conf = new Confhub<Conf>('confName'); 
   
   // return entire configuration object
   const entireConf = await conf.query();
   
   // or query configuration by path
   // const value = await conf.query('b'); // boolean
   // const value = await conf.query('d'); // { something: Array<string>, num: number }
   // const value = await conf.query('d.something'); // Array<string>