Skip to content

doc: improve assert documentation #22692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BridgeAR wants to merge 3 commits into from
Closed

doc: improve assert documentation #22692

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
278b1b6
doc: improve assert documentation
BridgeAR Sep 3, 2018
2d152ed
fixup: address comment
BridgeAR Sep 5, 2018
1ed83bf
fixup: address Anna's comment
BridgeAR Sep 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fixup: address Anna's comment
  • Loading branch information
@BridgeAR
BridgeAR committed Sep 5, 2018
commit 1ed83bf2168f2191689c7663c46bc91a268c4ae8
18 changes: 9 additions & 9 deletions doc/api/assert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,19 +408,19 @@ parameter is undefined, a default error message is assigned. If the `message`
parameter is an instance of an [`Error`][] then it will be thrown instead of the
`AssertionError`.

## assert.doesNotReject(promiseFn[, error][, message])
## assert.doesNotReject(asyncFn[, error][, message])
<!-- YAML
added: v10.0.0
-->
* `promiseFn` {Function|Promise}
* `asyncFn` {Function|Promise}
* `error` {RegExp|Function}
* `message` {string}

Awaits the `promiseFn` promise or, if `promiseFn` is a function, immediately
Awaits the `asyncFn` promise or, if `asyncFn` is a function, immediately
calls the function and awaits the returned promise to complete. It will then
check that the promise is not rejected.

If `promiseFn` is a function and it throws an error synchronously,
If `asyncFn` is a function and it throws an error synchronously,
`assert.doesNotReject()` will return a rejected `Promise` with that error. If
the function does not return a promise, `assert.doesNotReject()` will return a
rejected `Promise` with an [`ERR_INVALID_RETURN_VALUE`][] error. In both cases
Expand Down Expand Up @@ -964,19 +964,19 @@ assert(0);
// assert(0)
```

## assert.rejects(promiseFn[, error][, message])
## assert.rejects(asyncFn[, error][, message])
<!-- YAML
added: v10.0.0
-->
* `promiseFn` {Function|Promise}
* `asyncFn` {Function|Promise}
* `error` {RegExp|Function|Object|Error}
* `message` {string}

Awaits the `promiseFn` promise or, if `promiseFn` is a function, immediately
Awaits the `asyncFn` promise or, if `asyncFn` is a function, immediately
calls the function and awaits the returned promise to complete. It will then
check that the promise is rejected.

If `promiseFn` is a function and it throws an error synchronously,
If `asyncFn` is a function and it throws an error synchronously,
`assert.rejects()` will return a rejected `Promise` with that error. If the
function does not return a promise, `assert.rejects()` will return a rejected
`Promise` with an [`ERR_INVALID_RETURN_VALUE`][] error. In both cases the error
Expand All @@ -991,7 +991,7 @@ each property will be tested for including the non-enumerable `message` and
`name` properties.

If specified, `message` will be the message provided by the `AssertionError` if
the `promiseFn` fails to reject.
the `asyncFn` fails to reject.

```js
(async () => {
Expand Down