is-windows

What is is-windows?

The is-windows npm package is a simple utility that determines if the current runtime environment is Windows. It's a straightforward package with a single primary function, which is to check the operating system.

What are is-windows's main functionalities?

Check if the OS is Windows

This feature allows developers to programmatically check if their code is running on a Windows operating system. This can be useful for writing platform-specific code or for runtime environment checks.

var isWindows = require('is-windows');
console.log(isWindows()); // returns true if running on Windows, false otherwise

Other packages similar to is-windows

os

The 'os' package is a core Node.js module that provides operating system-related utility methods. It is more comprehensive than is-windows, offering information such as the OS platform, architecture, release version, uptime, and more. Unlike is-windows, which is a single-purpose module for checking if the OS is Windows, 'os' can be used to gather a wide range of system details.

platform

The 'platform' package is a more feature-rich library that can parse and interpret information about the platform your code is running on. It can provide details such as the operating system, its version, the browser name and version, and even the device manufacturer and model. Compared to is-windows, 'platform' offers a broader set of features for identifying not just the OS but also the runtime environment in more detail.

check-os

The 'check-os' package is another utility that allows you to check the operating system of the user's environment. It supports methods to check for Windows, MacOS, and Linux. This package provides a bit more functionality than is-windows by covering more operating systems, but it still focuses on the same basic functionality of OS detection.

README

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

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:

• 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.

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