@zoroaster/assert

@zoroaster/assert is An Assertion Library For Zoroaster Context Testing Framework Including Deep Equal & Assert Throws.

yarn add -D @zoroaster/assert

Table Of Contents

• Table Of Contents
• API
• deepEqual(actual: ?, expected: ?, message=: string): void
• async assertThrows(config: _assertThrows.Config): void
  • _assertThrows.Assertion
  • _assertThrows.Config
• Copyright & License

API

The package is available by importing its named functions:

import deepEqual,
  throws,
  assert,
  equal,
  ok,
} from '@zoroaster/assert'

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

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

• actual* ?undefined: The actual value.
• expected* ?undefined: The expected value.
• message string (optional): The message with which to fail if the assertion didn't succeed.

async assertThrows(  config: _assertThrows.Config,): void

Assert that a function throws and check the thrown error properties.

await throws({
  fn: method,
  args: ['test', true],
  message: /An error occurred:/, // regex
  code: 'ENOTEST',               // string
  stack(stack) {                 // function
    equal(stack.length, 2)
  }
})

• config* _assertThrows.Config: Parameters to the assert-throws method.

!(string | RegExp | !Function) _assertThrows.Assertion: An assertion to perform.

_assertThrows.Config: Parameters to the assert-throws method.

| Name | Type | Description | | ------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | fn* | !Function | The function to test, either sync or async. | | args | (* | !Array<>) | The arguments or single argument to pass to the function. | | context | | The context in which to execute the function. Global context will be set by default. | | message | _assertThrows.Assertion | A string, regex, or function to test the message. | | code | _assertThrows.Assertion | A string, regex, or function to test the code. | | stack | _assertThrows.Assertion | A string, regex, or function to test the stack. | | prop | _assertThrows.Assertion | A string, regex, or function to test any other property of the error. | | error | Error | An error to perform strict comparison against. |

Copyright & License

GNU Affero General Public License v3.0