pixl-config 1.0.12 → 1.0.14

package/README.md

@@ -1,47 +1,47 @@
 # Overview
 
-This module provides a simple interface to your application's JSON configuration file on disk.  It will load and parse the file, and can automatically reload it when it changes (and emit an event when this happens).  Command-line arguments are automatically merged in with your config (uses [pixl-args](https://www.npmjs.com/package/pixl-args)), and treated as overrides.  The library also provides an easy way to determine the server's hostname and local IP address.
+This module provides a simple interface to your application's JSON configuration file on disk.  It will load and parse the file, and can automatically reload it when it changes (and emit an event when this happens).  Command-line arguments are automatically merged in with your config (uses [pixl-args](https://www.npmjs.com/package/pixl-args)), and treated as overrides.
 
 # Usage
 
 Use [npm](https://www.npmjs.com/) to install the module:
 
-```
+```sh
 npm install pixl-config
 ```
 
 Then use `require()` to load it in your code:
 
-```javascript
-var Config = require('pixl-config');
+```js
+const Config = require('pixl-config');
 ```
 
 To use the module, instantiate an object:
 
-```javascript
-var config = new Config('conf/config.json');
+```js
+let config = new Config('conf/config.json');
 ```
 
 If there is an error loading or parsing the file, an exception will be thrown, so you might want to wrap it in a try/catch.
 
 Upon success, you can access your configuration keys/values using the `get()` method:
 
-```javascript
-var verbose = config.get('verbose');
-var debug = config.get('debug');
+```js
+let verbose = config.get('verbose');
+let debug = config.get('debug');
 ```
 
 If you just want a hash of the entire config file, call `get()` without passing a key:
 
-```javascript
-var opts = config.get();
+```js
+let opts = config.get();
 if (opts.verbose) console.log("Verbose option is set.");
 if (opts.debug) console.log("Debug option is set.");
 ```
 
 You can also set values by calling `set()` and passing both a key and a value.  Example:
 
-```javascript
+```js
 config.set('verbose', true);
 ```
 
@@ -57,14 +57,14 @@ Please see the [pixl-args](https://www.npmjs.com/package/pixl-args) module for m
 
 If you want the library to monitor your configuration file for live changes and automatically reload it, pass `true` as a second argument to the constructor:
 
-```javascript
-var config = new Config('conf/config.json', true);
+```js
+let config = new Config('conf/config.json', true);
 ```
 
 This uses polling, and by default it checks the file for changes every 10 seconds.  The library then reloads the configuration and fires off an event you can listen for:
 
-```javascript
-var config = new Config('conf/config.json', true);
+```js
+let config = new Config('conf/config.json', true);
 
 config.on('reload', function() {
 	console.log("My app's config was reloaded!");
@@ -77,24 +77,13 @@ If there is an error reloading the configuration, an `error` event is emitted (n
 To set the polling frequency, pass in the desired number of milliseconds instead of `true` as the second argument.  For example, to check every five seconds pass in `5000`:
 
 ```js
-var config = new Config('conf/config.json', 5000);
+let config = new Config('conf/config.json', 5000);
 ```
 
 To stop monitoring (for example during your app's shutdown sequence) call the `stop()` method.
 
 If you would prefer to control exactly when to check for changes, do not enable live monitoring, and instead simply call the `check()` method at any frequency you want.
 
-## Server Environment
-
-The library also provides a utility method for determining the server's hostname and IP address (IPv4).  These things may require asynchronous operations, so you must specify a callback function.  Upon completion, the hostname will be accessible via `config.hostname` and the IP address in `config.ip` (IPv4 dot-delimited string).  Example:
-
-```javascript
-config.getEnv( function() {
-	console.log("The server hostname is: " + config.hostname);
-	console.log("The server IP is: " + config.ip);
-} );
-```
-
 # License
 
 **The MIT License**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pixl-config",
-	"version": "1.0.12",
+	"version": "1.0.14",
 	"description": "A simple JSON configuration loader.",
 	"author": "Joseph Huckaby <jhuckaby@gmail.com>",
 	"homepage": "https://github.com/jhuckaby/pixl-config",
@@ -18,9 +18,9 @@
 		"config"
 	],
 	"dependencies": {
-		"pixl-class": "^1.0.0",
+		"pixl-class": "^1.0.3",
 		"pixl-args": "^1.0.0",
-		"pixl-tools": "^1.0.0"
+		"pixl-tools": "^2.0.2"
 	},
 	"devDependencies": {}
 }