Skip to content
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

Jump to bottom

doc: update promisify() docs with behavior when bad arguments are passed #17593

Closed
wants to merge 3 commits into from
Closed

doc: update promisify() docs with behavior when bad arguments are passed #17593

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2067648
doc: update promisify docs with behavior when bad arguments are passed
ramsgoli Dec 10, 2017
1c272f9
doc: use 'Node.js style' callback
ramsgoli Dec 10, 2017
e215574
doc: fix line length and wording
ramsgoli Dec 12, 2017
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
8 changes: 6 additions & 2 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,8 +552,10 @@ If there is an `original[util.promisify.custom]` property present, `promisify`
will return its value, see [Custom promisified functions][].

`promisify()` assumes that `original` is a function taking a callback as its
final argument in all cases, and the returned function will result in undefined
behavior if it does not.
final argument in all cases. If `original` is not a function, `promisify()`
will throw an error. If `original` is a function but its last argument is not a
Node.js style callback, it will still be passed a Node.js style callback
as its last argument.

### Custom promisified functions

Expand Down Expand Up @@ -588,6 +590,8 @@ doSomething[util.promisify.custom] = (foo) => {
});
};
```
If `promisify.custom` is defined but is not a function, `promisify()` will
throw an error.

### util.promisify.custom
<!-- YAML
Expand Down