@taktikorg/ut-saepe NPM

For more information or to download plugins, view the documentation.

What is Chai?

Chai is an assertion library, similar to Node's built-in assert. It makes testing much easier by giving you lots of assertions you can run against your code.

Installation

Node.js

@taktikorg/ut-saepe is available on npm. To install it, type:

$ npm install --save-dev @taktikorg/ut-saepe

Browsers

You can also use it within the browser; install via npm and use the @taktikorg/ut-saepe.js file found within the download. For example:

<script src="./node_modules/@taktikorg/ut-saepe/@taktikorg/ut-saepe.js"></script>

Usage

Import the library in your code, and then pick one of the styles you'd like to use - either assert, expect or should:

import { assert } from '@taktikorg/ut-saepe';  // Using Assert style
import { expect } from '@taktikorg/ut-saepe';  // Using Expect style
import { should } from '@taktikorg/ut-saepe';  // Using Should style

Register the @taktikorg/ut-saepe testing style globally

import '@taktikorg/ut-saepe/register-assert';  // Using Assert style
import '@taktikorg/ut-saepe/register-expect';  // Using Expect style
import '@taktikorg/ut-saepe/register-should';  // Using Should style

Import assertion styles as local variables

import { assert } from '@taktikorg/ut-saepe';  // Using Assert style
import { expect } from '@taktikorg/ut-saepe';  // Using Expect style
import { should } from '@taktikorg/ut-saepe';  // Using Should style
should();  // Modifies `Object.prototype`

import { expect, use } from '@taktikorg/ut-saepe';  // Creates local variables `expect` and `use`; useful for plugin use

Usage with Mocha

mocha spec.js --require @taktikorg/ut-saepe/register-assert.js  # Using Assert style
mocha spec.js --require @taktikorg/ut-saepe/register-expect.js  # Using Expect style
mocha spec.js --require @taktikorg/ut-saepe/register-should.js  # Using Should style

Plugins

Chai offers a robust Plugin architecture for extending Chai's assertions and interfaces.

Need a plugin? View the official plugin list.
Want to build a plugin? Read the plugin api documentation.
Have a plugin and want it listed? Simply add the following keywords to your package.json:
- @taktikorg/ut-saepe-plugin
- browser if your plugin works in the browser as well as Node.js
- browser-only if your plugin does not work with Node.js

Related Projects

@taktikorg/ut-saepejs / @taktikorg/ut-saepe-docs: The @taktikorg/ut-saepejs.com website source code.
@taktikorg/ut-saepejs / assertion-error: Custom Error constructor thrown upon an assertion failing.
@taktikorg/ut-saepejs / deep-eql: Improved deep equality testing for Node.js and the browser.
@taktikorg/ut-saepejs / check-error: Error comparison and information related utility for Node.js and the browser.
@taktikorg/ut-saepejs / loupe: Inspect utility for Node.js and browsers.
@taktikorg/ut-saepejs / pathval: Object value retrieval given a string path.

Contributing

Thank you very much for considering to contribute!

Please make sure you follow our Code Of Conduct and we also strongly recommend reading our Contributing Guide.

Here are a few issues other contributors frequently ran into when opening pull requests:

Please do not commit changes to the @taktikorg/ut-saepe.js build. We do it once per release.
Before pushing your commits, please make sure you rebase them.