TylorSAssertionError Diff
Get It
npm install --save assertion-error-diff
# or
yarn add assertion-error-diff
API
<summary id=createAssertionError>createAssertionError :: string -> a -> a -> AssertionError a</summary>
Creates an AssertionError
Example:
typescript
import { createAssertionError } from 'assertion-error-diff'
const error = createAssertionError('Not a truthy value', true, false)
throw error
<summary id=errorToString>errorToString :: Error -> string</summary>
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
<summary id=isAssertionError>isAssertionError :: Error -> boolean</summary>
Given an Error it returns true if that Error is an AssertionErrorfalse otherwise.
Example:
typescript
import { isAssertionError, createAssertionError } from 'assertion-error-diff'
isAssertionError(new Error('foo')) // false
isAssertionError(createAssertionError('foo', 'bar', 'baz')) // true