sfcode: is-windows <a href="https://www.npmjs.com/package/is-windows"><img src="https://img.shields.io/npm/v/is-windows.svg?style=flat" alt="NPM version"/></a> <a href="https://npmjs.org/package/is-windows"><img src="https://img.shields.io/npm/dm/is-windows.svg?style=flat" alt="NPM monthly downloads"/></a> <a href="https://npmjs.org/package/is-windows"><img src="https://img.shields.io/npm/dt/is-windows.svg?style=flat" alt="NPM total downloads"/></a> <a href="https://travis-ci.org/jonschlinkert/is-windows"><img src="https://img.shields.io/travis/jonschlinkert/is-windows.svg?style=flat&label=Travis" alt="Linux Build Status"/></a>
is-windows

Contributing

> 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

<details>

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

</details>

<details>

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

</details>

<details>

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

</details>

## Related projects

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

## Contributors

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

## Author

Jon Schlinkert

- linkedin/in/jonschlinkert
- github/jonschlinkert
- twitter/jonschlinkert

## License

Copyright © 2018, Jon Schlinkert. Released under the [MIT License](LICENSE).

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