Skip to content

Commit

Permalink
read me
Browse files Browse the repository at this point in the history
  • Loading branch information
ljharb committed Jan 20, 2014
1 parent c06f7dc commit 5c8bf3c
Showing 1 changed file with 46 additions and 2 deletions.
48 changes: 46 additions & 2 deletions README.md
@@ -1,4 +1,48 @@
is-negative-zero
================
#is-negative-zero <sup>[![Version Badge][2]][1]</sup>

[![Build Status][3]][4] [![dependency status][5]][6] [![dev dependency status][7]][8]

[![npm badge][11]][1]

[![browser support][9]][10]

Is this value negative zero? === will lie to you.

## Example

```js
var isNegativeZero = require('is-negative-zero');
var assert = require('assert');

assert.notOk(isNegativeZero(undefined));
assert.notOk(isNegativeZero(null));
assert.notOk(isNegativeZero(false));
assert.notOk(isNegativeZero(true));
assert.notOk(isNegativeZero(0));
assert.notOk(isNegativeZero(42));
assert.notOk(isNegativeZero(Infinity));
assert.notOk(isNegativeZero(-Infinity));
assert.notOk(isNegativeZero(NaN));
assert.notOk(isNegativeZero('foo'));
assert.notOk(isNegativeZero(function () {}));
assert.notOk(isNegativeZero([]));
assert.notOk(isNegativeZero({}));

assert.ok(isNegativeZero(-0));
```

## Tests
Simply clone the repo, `npm install`, and run `npm test`

[1]: https://npmjs.org/package/is-negative-zero
[2]: http://vb.teelaun.ch/ljharb/is-negative-zero.svg
[3]: https://travis-ci.org/ljharb/is-negative-zero.png
[4]: https://travis-ci.org/ljharb/is-negative-zero
[5]: https://david-dm.org/ljharb/is-negative-zero.png
[6]: https://david-dm.org/ljharb/is-negative-zero
[7]: https://david-dm.org/ljharb/is-negative-zero/dev-status.png
[8]: https://david-dm.org/ljharb/is-negative-zero#info=devDependencies
[9]: https://ci.testling.com/ljharb/is-negative-zero.png
[10]: https://ci.testling.com/ljharb/is-negative-zero
[11]: https://nodei.co/npm/is-negative-zero.png?downloads=true&stars=true

0 comments on commit 5c8bf3c

Please sign in to comment.