starrating: What the Package Does (One Line, Title Case)

is-windows

Returns true if the platform is windows. UMD module, works with node.js, commonjs, browser, AMD, electron, etc.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install with npm:

$ npm install --save is-windows

As of v0.2.0 this module always returns a function.

var isWindows = require('is-windows');

console.log(isWindows());
//=> returns true if the platform is windows

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

You might also be interested in these projects:

is-absolute: Returns true if a file path is absolute. Does not rely on the path module… more | homepage
is-glob: Returns true if the given string looks like a glob pattern or an extglob pattern… more | homepage
is-relative: Returns true if the path appears to be relative. | homepage
isobject: Returns true if the value is an object and not an array or null. | homepage
window-size: Reliable way to get the height and width of terminal/console, since it's not calculated or… more | homepage