Is Windows

Returns a boolean indicating if the current process is running on Windows.

Installation

$ npm install check-if-windows

Usage

var isWindows = require( 'check-if-windows' );

isWindows

Boolean indicating if the current process is running on Windows.

console.log( isWindows );
// returns <boolean>

Examples

var isWindows = require( 'check-if-windows' );

if ( isWindows ) {
	console.log( 'Running on Windows...' );
} else {
	console.log( 'Running on %s...', process.platform );
}

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.