| [6a3a178] | 1 | # is-windows [](https://www.npmjs.com/package/is-windows) [](https://npmjs.org/package/is-windows) [](https://npmjs.org/package/is-windows) [](https://travis-ci.org/jonschlinkert/is-windows)
|
|---|
| 2 |
|
|---|
| 3 | > Returns true if the platform is windows. UMD module, works with node.js, commonjs, browser, AMD, electron, etc.
|
|---|
| 4 |
|
|---|
| 5 | Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
|
|---|
| 6 |
|
|---|
| 7 | ## Install
|
|---|
| 8 |
|
|---|
| 9 | Install with [npm](https://www.npmjs.com/):
|
|---|
| 10 |
|
|---|
| 11 | ```sh
|
|---|
| 12 | $ npm install --save is-windows
|
|---|
| 13 | ```
|
|---|
| 14 |
|
|---|
| 15 | ## Heads up!
|
|---|
| 16 |
|
|---|
| 17 | As of `v0.2.0` this module always returns a function.
|
|---|
| 18 |
|
|---|
| 19 | ## Node.js usage
|
|---|
| 20 |
|
|---|
| 21 | ```js
|
|---|
| 22 | var isWindows = require('is-windows');
|
|---|
| 23 |
|
|---|
| 24 | console.log(isWindows());
|
|---|
| 25 | //=> returns true if the platform is windows
|
|---|
| 26 | ```
|
|---|
| 27 |
|
|---|
| 28 | ## About
|
|---|
| 29 |
|
|---|
| 30 | <details>
|
|---|
| 31 | <summary><strong>Contributing</strong></summary>
|
|---|
| 32 |
|
|---|
| 33 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
|---|
| 34 |
|
|---|
| 35 | </details>
|
|---|
| 36 |
|
|---|
| 37 | <details>
|
|---|
| 38 | <summary><strong>Running Tests</strong></summary>
|
|---|
| 39 |
|
|---|
| 40 | 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:
|
|---|
| 41 |
|
|---|
| 42 | ```sh
|
|---|
| 43 | $ npm install && npm test
|
|---|
| 44 | ```
|
|---|
| 45 |
|
|---|
| 46 | </details>
|
|---|
| 47 |
|
|---|
| 48 | <details>
|
|---|
| 49 | <summary><strong>Building docs</strong></summary>
|
|---|
| 50 |
|
|---|
| 51 | _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
|
|---|
| 52 |
|
|---|
| 53 | To generate the readme, run the following command:
|
|---|
| 54 |
|
|---|
| 55 | ```sh
|
|---|
| 56 | $ npm install -g verbose/verb#dev verb-generate-readme && verb
|
|---|
| 57 | ```
|
|---|
| 58 |
|
|---|
| 59 | </details>
|
|---|
| 60 |
|
|---|
| 61 | ### Related projects
|
|---|
| 62 |
|
|---|
| 63 | You might also be interested in these projects:
|
|---|
| 64 |
|
|---|
| 65 | * [is-absolute](https://www.npmjs.com/package/is-absolute): Returns true if a file path is absolute. Does not rely on the path module… [more](https://github.com/jonschlinkert/is-absolute) | [homepage](https://github.com/jonschlinkert/is-absolute "Returns true if a file path is absolute. Does not rely on the path module and can be used as a polyfill for node.js native `path.isAbolute`.")
|
|---|
| 66 | * [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
|
|---|
| 67 | * [is-relative](https://www.npmjs.com/package/is-relative): Returns `true` if the path appears to be relative. | [homepage](https://github.com/jonschlinkert/is-relative "Returns `true` if the path appears to be relative.")
|
|---|
| 68 | * [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject "Returns true if the value is an object and not an array or null.")
|
|---|
| 69 | * [window-size](https://www.npmjs.com/package/window-size): Reliable way to get the height and width of terminal/console, since it's not calculated or… [more](https://github.com/jonschlinkert/window-size) | [homepage](https://github.com/jonschlinkert/window-size "Reliable way to get the height and width of terminal/console, since it's not calculated or updated the same way on all platforms, environments and node.js versions.")
|
|---|
| 70 |
|
|---|
| 71 | ### Contributors
|
|---|
| 72 |
|
|---|
| 73 | | **Commits** | **Contributor** |
|
|---|
| 74 | | --- | --- |
|
|---|
| 75 | | 11 | [jonschlinkert](https://github.com/jonschlinkert) |
|
|---|
| 76 | | 4 | [doowb](https://github.com/doowb) |
|
|---|
| 77 | | 1 | [SimenB](https://github.com/SimenB) |
|
|---|
| 78 | | 1 | [gucong3000](https://github.com/gucong3000) |
|
|---|
| 79 |
|
|---|
| 80 | ### Author
|
|---|
| 81 |
|
|---|
| 82 | **Jon Schlinkert**
|
|---|
| 83 |
|
|---|
| 84 | * [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
|
|---|
| 85 | * [github/jonschlinkert](https://github.com/jonschlinkert)
|
|---|
| 86 | * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
|
|---|
| 87 |
|
|---|
| 88 | ### License
|
|---|
| 89 |
|
|---|
| 90 | Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
|
|---|
| 91 | Released under the [MIT License](LICENSE).
|
|---|
| 92 |
|
|---|
| 93 | ***
|
|---|
| 94 |
|
|---|
| 95 | _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 14, 2018._ |
|---|
