@zoroaster/assert
The Assertion Library For Zoroaster Context Testing Framework Including Deep Equal & Assert Throws.
Last updated 7 months ago by zvr .
AGPL-3.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @zoroaster/assert 
SYNC missed versions from official npm registry.

@zoroaster/assert

npm version Pipeline Badge

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

yarn add -D @zoroaster/assert

Table Of Contents

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)
  }
})

!(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

Art Deco © Art Deco™ for ContextTesting 2020 ContextTesting AGPL-3.0

Current Tags

  • 1.1.1                                ...           latest (7 months ago)

4 Versions

  • 1.1.1                                ...           7 months ago
  • 1.0.2                                ...           a year ago
  • 1.0.1                                ...           a year ago
  • 1.0.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 8
This Month 12
Last Day 0
Last Week 4
Last Month 34
Dependencies (0)
None
Dev Dependencies (8)
Dependents (2)

Copyright 2014 - 2016 © taobao.org |