doc: clarify usage of util.promisify.custom #16134
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
Qard
approved these changes
Oct 11, 2017
evanlucas
approved these changes
Oct 11, 2017
jasnell
reviewed
Oct 13, 2017
doc/api/util.md
Outdated
| @@ -525,6 +525,16 @@ console.log(promisified === doSomething[util.promisify.custom]); | |||
| This can be useful for cases where the original function does not follow the | |||
| standard format of taking an error-first callback as the last argument. | |||
|
|
|||
| For example, if you have a pattern that takes in `(foo, onSuccessCallback, onErrorCallback)`, you can do: | |||
There was a problem hiding this comment.
Couple nits: please avoid the use of the informal pronoun you in the docs. In fact, I would just remove everything after For example:
jasnell
requested changes
Oct 13, 2017
|
Somehow messed up the commits... Should I close this PR and open a new one? |
Per requested changes. Since the code will only work for the described pattern.
shiya
force-pushed
the
custom-promisify
branch
from
623a4ff to
ca0229f
Compare
|
Ah, fixed it 😅 learned something about rebase today. @jasnell can you review again at your leisure? Thanks! |
jasnell
approved these changes
Oct 13, 2017
jasnell
pushed a commit
that referenced
this pull request
Oct 13, 2017
PR-URL: #16134 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]>
addaleax
pushed a commit
to ayojs/ayo
that referenced
this pull request
Oct 15, 2017
PR-URL: nodejs/node#16134 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]>
targos
pushed a commit
that referenced
this pull request
Oct 18, 2017
PR-URL: #16134 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hoping this addition will help people using
util.promisify.customwithout having to read the source code.Checklist
Affected core subsystem(s)
doc