ssube
/
mocha-foam
1
0
Fork 0
Code

note peer dep, async tests

This commit is contained in:
ssube 2021-07-25 12:22:55 -05:00
parent 0632d58d52
commit 6acc8580a8
Signed by: ssube
GPG Key ID: 3EED7B957D362AF1
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -13,10 +13,10 @@ An experimental Mocha BDD wrapper for fast-check.
## Install
Add `mocha-foam` to your project as a dev dependency:
Add `mocha-foam` to your project as a dev dependency, along with `fast-check`, if you are not already using it:
```shell
> yarn add -D mocha-foam
> yarn add -D fast-check mocha-foam
```
## Usage
@ -44,7 +44,8 @@ describe('example properties', () => {
});
```
Assertions can be made through `expect` (and the other chai assertions) or by returning a boolean.
Assertions can be made through `expect` (and the other chai assertions) or by returning a boolean, and may be `async`
functions. The test callbacks are called with a Mocha context, so [the usual caveats](https://mochajs.org/#arrow-functions) apply.
Note the wrapped `it` passed to the suite callback by `over`. This calls through to Mocha's `it`, after wrapping the
test in a fast-check property. Most Mocha features, like `beforeEach` and `afterEach` hooks, work correctly within