# platform-is

> Returns true if the platform is windows/linux/mac.

Latest version **1.0.4** (published 2017-08-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install platform-is
pnpm add platform-is
yarn add platform-is
bun add platform-is
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2017-08-01 |
| First published | 2017-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Dmirty Poddubniy |
| Maintainers | mr47 |
| Keywords | check, cywin, is, is-windows, is-linux, is-mac, nix, operating system, os, platform, process, unix, win, win32, windows, linux, mac |

## Links

- npm: https://www.npmjs.com/package/platform-is
- Repository: https://github.com/mr47/platform-is
- Issues: https://github.com/mr47/platform-is/issues
- npm.io page: https://npm.io/package/platform-is

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2017-08-01
- 1.0.3 — 2017-08-01
- 1.0.2 — 2017-08-01
- 1.0.0 — 2017-07-31

## README

# platform-is [![NPM version](https://img.shields.io/npm/v/platform-is.svg?style=flat)](https://www.npmjs.com/package/platform-is) [![NPM monthly downloads](https://img.shields.io/npm/dm/platform-is.svg?style=flat)](https://npmjs.org/package/platform-is)  [![NPM total downloads](https://img.shields.io/npm/dt/platform-is.svg?style=flat)](https://npmjs.org/package/platform-is) [![Linux Build Status](https://img.shields.io/travis/mr47/platform-is.svg?style=flat&label=Travis)](https://travis-ci.org/mr47/platform-is)

> Returns true if the platform is windows.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save platform-is
```

## Heads up!

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

## Usage

```js
var isWindows = require('platform-is');
var isMac = require('platform-is').isMac;
var isLinux = require('platform-is').isLinux;
isMac();
isLinux();
isWindows();
//=> returns true if the platform is windows, same for linux, mac
```

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Building docs

_(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.)_

To generate the readme, run the following command:

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

### 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:

```sh
$ npm install && npm test
```

### License

Copyright © 2017, [Dmitry Poddubniy](https://github.com/mr47).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 28, 2017._

---
_Source: https://npm.io/package/platform-is · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._