README: Update with description and methods
This commit is contained in:
parent
cff88dc218
commit
e7415c4c96
38
README.md
38
README.md
|
@ -1,2 +1,38 @@
|
|||
# assert-extended
|
||||
Core assert library extended slightly with few more assertion methods
|
||||
A complimenting library for `require('assert')` with a few more assertions being made available.
|
||||
|
||||
# Installation
|
||||
|
||||
```
|
||||
npm install assert-extended --save-dev
|
||||
```
|
||||
|
||||
# Usage
|
||||
|
||||
Add the following anywhere in your test:
|
||||
|
||||
```
|
||||
require('assert-extended');
|
||||
```
|
||||
|
||||
And you're good to go.
|
||||
|
||||
# Assert
|
||||
|
||||
Including the default ones that come with `assert` the following are added:
|
||||
|
||||
### assert.notOk(value, message)
|
||||
|
||||
Asserts value is a falsy value.
|
||||
|
||||
### assert.isFulfilled(promise, message)
|
||||
|
||||
Asserts that the promise is fulfilled.
|
||||
|
||||
### assert.isRejected(promise, message)
|
||||
|
||||
Asserts that the promise is rejected.
|
||||
|
||||
### assert.match(value, test, message)
|
||||
|
||||
Asserts that the value RexExp matches the test.
|
||||
|
|
Loading…
Reference in New Issue