包详细信息

# @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.

• <kbd>actual*</kbd> ?undefined: The actual value.
• <kbd>expected*</kbd> ?undefined: The expected value.
• <kbd>message</kbd> 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)
    }
  })

• <kbd>config*</kbd> _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.

Copyright & License

GNU Affero General Public License v3.0

	© Art Deco™ for ContextTesting 2020