# math-sign-x

> Shim for Math.sign.

Latest version **4.2.2** (published 2019-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install math-sign-x
pnpm add math-sign-x
yarn add math-sign-x
bun add math-sign-x
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.2.2 |
| Published | 2019-08-28 |
| First published | 2017-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8.11.4 |
| Dependencies | 2 |
| Unpacked size | 222.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Graham Fairweather |
| Maintainers | xotic750 |
| Keywords | math, sign, module, javascript, nodejs, browser |

## Links

- npm: https://www.npmjs.com/package/math-sign-x
- Repository: https://github.com/Xotic750/math-sign-x
- Issues: https://github.com/Xotic750/math-sign-x/issues
- npm.io page: https://npm.io/package/math-sign-x

## Dependencies (2)

- [is-nan-x](https://npm.io/package/is-nan-x.md) ^2.1.1
- [to-number-x](https://npm.io/package/to-number-x.md) ^3.2.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 4.2.2 (latest) — 2019-08-28
- 4.2.1 — 2019-08-20
- 4.2.0 — 2019-08-14
- 4.1.0 — 2019-08-14
- 4.0.30 — 2019-07-31
- 4.0.28 — 2019-07-27
- 4.0.27 — 2019-07-27
- 4.0.26 — 2019-07-26
- 4.0.25 — 2019-07-25
- 4.0.24 — 2019-07-24
- 4.0.23 — 2019-07-24
- 4.0.22 — 2019-07-24
- 4.0.20 — 2019-07-22
- 4.0.19 — 2019-07-21
- 4.0.18 — 2019-07-19
- … 25 more at https://npm.io/package/math-sign-x/versions

## README

<a
  href="https://travis-ci.org/Xotic750/math-sign-x"
  title="Travis status">
<img
  src="https://travis-ci.org/Xotic750/math-sign-x.svg?branch=master"
  alt="Travis status" height="18">
</a>
<a
  href="https://david-dm.org/Xotic750/math-sign-x"
  title="Dependency status">
<img src="https://david-dm.org/Xotic750/math-sign-x/status.svg"
  alt="Dependency status" height="18"/>
</a>
<a
  href="https://david-dm.org/Xotic750/math-sign-x?type=dev"
  title="devDependency status">
<img src="https://david-dm.org/Xotic750/math-sign-x/dev-status.svg"
  alt="devDependency status" height="18"/>
</a>
<a
  href="https://badge.fury.io/js/math-sign-x"
  title="npm version">
<img src="https://badge.fury.io/js/math-sign-x.svg"
  alt="npm version" height="18">
</a>
<a
  href="https://www.jsdelivr.com/package/npm/math-sign-x"
  title="jsDelivr hits">
<img src="https://data.jsdelivr.com/v1/package/npm/math-sign-x/badge?style=rounded"
  alt="jsDelivr hits" height="18">
</a>
<a
  href="https://bettercodehub.com/results/Xotic750/math-sign-x"
  title="bettercodehub score">
<img src="https://bettercodehub.com/edge/badge/Xotic750/math-sign-x?branch=master"
  alt="bettercodehub score" height="18">
</a>
<a
  href="https://coveralls.io/github/Xotic750/math-sign-x?branch=master"
  title="Coverage Status">
<img src="https://coveralls.io/repos/github/Xotic750/math-sign-x/badge.svg?branch=master"
  alt="Coverage Status" height="18">
</a>

<a name="module_math-sign-x"></a>

## math-sign-x

Shim for Math.sign.

### `module.exports(x)` ⇒ <code>\*</code> ⏏

<a name="module_math-sign-x"></a>

### `math-sign-x` ⇒ <code>number</code>

This method returns the sign of a number, indicating whether the number is positive,
negative or zero. (ES2019)

**Kind**: static property of [<code>math-sign-x</code>](#module_math-sign-x)  
**Returns**: <code>number</code> - A number representing the sign of the given argument. If the argument
is a positive number, negative number, positive zero or negative zero, the function will
return 1, -1, 0 or -0 respectively. Otherwise, NaN is returned.

| Param | Type            | Description |
| ----- | --------------- | ----------- |
| x     | <code>\*</code> | A number.   |

**Example**

```js
import mathSign from 'math-sign-x';

console.log(mathSign(3)); //  1
console.log(mathSign(-3)); // -1
console.log(mathSign('-3')); // -1
console.log(mathSign(0)); //  0
console.log(mathSign(-0)); // -0
console.log(mathSign(NaN)); // NaN
console.log(mathSign('foo')); // NaN
console.log(mathSign()); // NaN
```

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