utils-fs-read-properties

.properties
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]

> Reads the entire contents of a .properties file.

Installation

`` bash
$ npm install utils-fs-read-properties
`

Usage

` javascript
var read = require( 'utils-fs-read-properties' );
`

#### read( path, [ options,] clbk )

Reads the entire contents of a .properties file.

` javascript
read( '/path/to/data.properties', onData );

function onData( error, data ) {
if ( error ) {
console.error( error );
} else {
console.log( data );
}
}
`

The function accepts the same options as properties#parse, except path is __always__ true.

` javascript
var opts = {
'sections': true
};

read( '/path/to/data.properties', opts, onData );

function onData( error, data ) {
if ( error ) {
console.error( error );
} else {
console.log( data );
}
}
`


#### read.sync( path[, options] )

Synchronously reads the contents of an entire .properties file.

` javascript
var out = read.sync( '/path/to/data.properties' );
if ( out instanceof Error ) {
throw out;
}
console.log( out );
`

The function accepts the same options as fs.readFileSync() as well as utils-properties-parse options.

Examples

` javascript
var path = require( 'path' ),
read = require( 'utils-fs-read-properties' );

var file = path.join( __dirname, 'config.properties' );

/**
* .properties reviver.
*
* @param {String} key - .properties key
* @param {String} value - .properties value
* @param {String} section - .properties section
@returns {} revived value
*/
function reviver( key, value ) {
/ jshint validthis:true /
var vals;

// Do not split section lines...
if ( this.isSection ) {
return this.assert();
}
// Split comma-delimited strings...
if ( typeof value === 'string' ){
vals = value.split( ',' );
return ( vals.length === 1 ) ? value : vals;
}
// Do not split the rest of the lines:
return this.assert();
}

// Sync:
var data = read.sync( file, {
'sections': true,
'namespaces': true,
'reviver': reviver
});
// returns