utils-fs-read-properties

Reads the entire contents of a .properties file.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
utils-fs-read-properties
1.0.07 years ago7 years agoMinified + gzip package size for utils-fs-read-properties in KB

Readme

.properties
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscodecov-imagecodecov-url !Dependenciesdependencies-imagedependencies-url
Reads the entire contents of a .properties file.

Installation

$ npm install utils-fs-read-properties

Usage

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

read( path, options, clbk )

Reads the entire contents of a .properties file.
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.
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.
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

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 <object>

console.log( data instanceof Error );
// returns false

data = read.sync( 'beepboop' );
// returns <error>

console.log( data instanceof Error );
// returns true


// Async:
read( file, {
	'sections': true,
	'namespaces': true,
	'reviver': reviver
}, onRead );
read( 'beepboop', onRead );

function onRead( error, config ) {
	if ( error ) {
		if ( error.code === 'ENOENT' ) {
			console.error( '.properties file does not exist.' );
		} else {
			throw error;
		}
	} else {
		console.log( 'Port: %s.', config.server.port );
	}
}

To run the example code from the top-level application directory,
$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,
$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.