@zoroaster/deep-equal


@zoroaster/deep-equal is The Deep Equal Assertion With Color.

``sh
yarn add @zoroaster/deep-equal
`

Table Of Contents

- Table Of Contents
- API
- deepEqual(actual: ?, expected: ?, message?: string)
- Copyright

API

The package is available by importing its default function:

`js
import deepEqual from '@zoroaster/deep-equal'
`

deepEqual(
  actual: ?,
  expected: ?,
  message?: string,
): void

Calls assert.deepStrictEqual and then creates a visual representation of the difference between objects if it throws.

`js
import deepEqual from '@zoroaster/deep-equal'

const compare = (a, b) => {
try {
deepEqual(a, b)
} catch (err) {
console.log(err.message)
}
}

compare('hello', 'world')
compare([10, 4, 20], [100, 4, 30])
compare({ a: 'example', b: 10 }, { b: 10, c: 'context-testing' })
`

Copyright


(c) Context Testing 2019