Skip to content

Commit

Permalink
[readme] update readme from default branch
Browse files Browse the repository at this point in the history
  • Loading branch information
ljharb committed Oct 20, 2023
1 parent 11bd45b commit b0bca9a
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions readme.markdown
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# deep-equal
# deep-equal <sup>[![Version Badge][npm-version-svg]][package-url]</sup>

Node's `assert.deepEqual() algorithm` as a standalone module.
Node's `assert.deepEqual() algorithm` as a standalone module, that also works in browser environments.

This module is around [5 times faster](https://gist.github.com/2790507)
than wrapping `assert.deepEqual()` in a `try/catch`.
It mirrors the robustness of node's own `assert.deepEqual` and is robust against later builtin modification.

[![browser support](https://ci.testling.com/substack/node-deep-equal.png)](https://ci.testling.com/substack/node-deep-equal)
[![github actions][actions-image]][actions-url]
[![coverage][codecov-image]][codecov-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]

[![build status](https://secure.travis-ci.org/substack/node-deep-equal.png)](https://travis-ci.org/substack/node-deep-equal)
[![npm badge][npm-badge-png]][package-url]

# example

Expand All @@ -33,25 +35,39 @@ var deepEqual = require('deep-equal')

## deepEqual(a, b, opts)

Compare objects `a` and `b`, returning whether they are equal according to a
recursive equality algorithm.
Compare objects `a` and `b`, returning whether they are equal according to a recursive equality algorithm.

If `opts.strict` is `true`, use strict equality (`===`) to compare leaf nodes.
The default is to use coercive equality (`==`) because that's how
`assert.deepEqual()` works by default.
The default is to use coercive equality (`==`) because that's how `assert.deepEqual()` works by default.

# install

With [npm](http://npmjs.org) do:
With [npm](https://npmjs.org) do:

```
npm install deep-equal
```

# test

With [npm](http://npmjs.org) do:
With [npm](https://npmjs.org) do:

```
npm test
```

[package-url]: https://npmjs.org/package/deep-equal
[npm-version-svg]: https://versionbadg.es/inspect-js/deep-equal.svg
[deps-svg]: https://david-dm.org/inspect-js/node-deep-equal.svg
[deps-url]: https://david-dm.org/inspect-js/node-deep-equal
[dev-deps-svg]: https://david-dm.org/inspect-js/node-deep-equal/dev-status.svg
[dev-deps-url]: https://david-dm.org/inspect-js/node-deep-equal#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/deep-equal.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/deep-equal.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/deep-equal.svg
[downloads-url]: https://npm-stat.com/charts.html?package=deep-equal
[codecov-image]: https://codecov.io/gh/inspect-js/node-deep-equal/branch/main/graphs/badge.svg
[codecov-url]: https://app.codecov.io/gh/inspect-js/node-deep-equal/
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/node-deep-equal
[actions-url]: https://github.com/inspect-js/node-deep-equal/actions

0 comments on commit b0bca9a

Please sign in to comment.