A small library for creating AssertionError diffs
npm install assertion-error-diffsh
npm install --save assertion-error-diff
or
yarn add assertion-error-diff
`API
createAssertionError :: string -> a -> a -> AssertionError a
Creates an AssertionError
Example:
typescript
import { createAssertionError } from 'assertion-error-diff'const error = createAssertionError('Not a truthy value', true, false)
throw error
`
errorToString :: Error -> string
Given an Error it will create a string representation. If the Error given
is an AssertionError it will create a diff of the expected and actual values.
Example:
typescript
import { errorToString, createAsssertionError } from 'assertion-error-diff'errorToString(new Error('foo')) // 'Error: foo'
errorToString(createAssertionError('foo', 'bar', 'baz'))
// AssertionError: foo
// - expected + actual
//
// bar !== baz
`
isAssertionError :: Error -> boolean
Given an Error it returns true if that Error is an AssertionError
false otherwise.
Example:
typescript
import { isAssertionError, createAssertionError } from 'assertion-error-diff'isAssertionError(new Error('foo')) // false
isAssertionError(createAssertionError('foo', 'bar', 'baz')) // true
``