utils-platform v1.0.0

Platform

Returns the platform on which the current process is running.

Installation

$ npm install utils-platform

Usage

var platform = require( 'utils-platform' );

platform

Alias for process.platform.

console.log( platform );

Examples

var platform = require( 'utils-platform' );

if ( platform === 'win32' ) {
	console.log( 'Running on a PC...' );
}
else if ( platform === 'darwin' ) {
	console.log( 'Running on a Mac...' );
}
else {
	console.log( 'Running on something else...' );
}

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.