summaryrefslogtreecommitdiff
path: root/src/node_modules/object-is/README.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
committerMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
commit46e43f4bde4a35785b4997b81e86cd19f046b69b (patch)
treec53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/object-is/README.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/object-is/README.md')
-rw-r--r--src/node_modules/object-is/README.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/src/node_modules/object-is/README.md b/src/node_modules/object-is/README.md
new file mode 100644
index 0000000..4ec5218
--- /dev/null
+++ b/src/node_modules/object-is/README.md
@@ -0,0 +1,58 @@
+#object-is <sup>[![Version Badge][2]][1]</sup>
+
+[![Build Status][3]][4]
+[![dependency status][5]][6]
+[![dev dependency status][7]][8]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][11]][1]
+
+ES2015-compliant shim for Object.is - differentiates between -0 and +0, and can compare to NaN.
+
+Essentially, Object.is returns the same value as === - but true for NaN, and false for -0 and +0.
+
+## Example
+
+```js
+Object.is = require('object-is');
+var assert = require('assert');
+
+assert.ok(Object.is());
+assert.ok(Object.is(undefined));
+assert.ok(Object.is(undefined, undefined));
+assert.ok(Object.is(null, null));
+assert.ok(Object.is(true, true));
+assert.ok(Object.is(false, false));
+assert.ok(Object.is('foo', 'foo'));
+
+var arr = [1, 2];
+assert.ok(Object.is(arr, arr));
+assert.notOk(Object.is(arr, [1, 2]));
+
+assert.ok(Object.is(0, 0));
+assert.ok(Object.is(-0, -0));
+assert.notOk(Object.is(0, -0));
+
+assert.ok(Object.is(NaN, NaN));
+assert.ok(Object.is(Infinity, Infinity));
+assert.ok(Object.is(-Infinity, -Infinity));
+```
+
+## Tests
+Simply clone the repo, `npm install`, and run `npm test`
+
+[1]: https://npmjs.org/package/object-is
+[2]: http://versionbadg.es/es-shims/object-is.svg
+[3]: https://travis-ci.org/es-shims/object-is.svg
+[4]: https://travis-ci.org/es-shims/object-is
+[5]: https://david-dm.org/es-shims/object-is.svg
+[6]: https://david-dm.org/es-shims/object-is
+[7]: https://david-dm.org/es-shims/object-is/dev-status.svg
+[8]: https://david-dm.org/es-shims/object-is#info=devDependencies
+[11]: https://nodei.co/npm/object-is.png?downloads=true&stars=true
+[license-image]: http://img.shields.io/npm/l/object-is.svg
+[license-url]: LICENSE
+[downloads-image]: http://img.shields.io/npm/dm/object-is.svg
+[downloads-url]: http://npm-stat.com/charts.html?package=object-is
+