Skip to content

Commit cbdbbb7

Browse files
committed
Clarify add() return value
Fixes #213
1 parent 47a4f19 commit cbdbbb7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

readme.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,9 @@ If `true`, specifies that any [pending](https://developer.mozilla.org/en-US/docs
116116

117117
#### .add(fn, options?)
118118

119-
Adds a sync or async task to the queue. Always returns a promise.
119+
Adds a sync or async task to the queue.
120+
121+
Returns a promise with the return value of `fn`.
120122

121123
Note: If your items can potentially throw an exception, you must handle those errors from the returned Promise or they may be reported as an unhandled Promise rejection and potentially cause your process to exit immediately.
122124

0 commit comments

Comments
 (0)