node_modules/is-windows/README.md

is-windows NPM version NPM monthly downloads NPM total downloads Linux Build Status

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

Install with npm:

$ npm install --save is-windows

Heads up!

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

Node.js usage

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

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

About

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

Related projects

You might also be interested in these projects:

Contributors

| Commits | Contributor | | --- | --- | | 11 | jonschlinkert | | 4 | doowb | | 1 | SimenB | | 1 | gucong3000 |

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on February 14, 2018.



thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.