doc: clarify usage of util.promisify.custom

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]>
nodejs · Oct 13, 2017 · cc258af · cc258af
1 parent 8d3e82f
commit cc258af
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/doc/api/util.md b/doc/api/util.md
@@ -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, with a function that takes in `(foo, onSuccessCallback, onErrorCallback)`:
+
+```js
+doSomething[util.promisify.custom] = function(foo) {
+  return new Promise(function(resolve, reject) {
+    doSomething(foo, resolve, reject);
+  });
+};
+```
+
 ### util.promisify.custom
 <!-- YAML
 added: v8.0.0