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

Improve documentation: async calls (#1286) #1655

Merged
merged 4 commits into from
Jan 16, 2018
Merged

Improve documentation: async calls (#1286) #1655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e4f8ad
Document async calls
ig-pj Jan 15, 2018
4fa1296
Merge branch 'master' into feature/1286-update-async-docs
ig-pj Jan 15, 2018
d0b139e
Update docs for the current release
ig-pj Jan 15, 2018
0aeb94c
Remove redundant indentation
ig-pj Jan 15, 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
44 changes: 33 additions & 11 deletions docs/_releases/v4.1.5/stubs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,28 +458,50 @@ Useful if a function is called with more than one callback, and simply calling t

Like `callArg`, but with arguments.

#### Asynchronous calls

#### `stub.callsArgAsync(index);`
Same as their corresponding non-Async counterparts, but with callback being deferred at called after all instructions in the current call stack are processed.

Same as their corresponding non-Async counterparts, but with callback being deferred (executed not immediately but after short timeout and in another "thread")
* In Node environment the callback is deferred with `process.nextTick`.
* In a browser the callback is deferred with `setTimeout(callback, 0)`.

#### `stub.callsArgAsync(index);`
More information:

#### `stub.callsArgOnAsync(index, context);`
* <https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick>,
* <https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop>,
* <https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout>.

#### `stub.callsArgWithAsync(index, arg1, arg2, ...);`
##### `stub.callsArgAsync(index);`

#### `stub.callsArgOnWithAsync(index, context, arg1, arg2, ...);`
Async version of [stub.callsArg(index)](#stubcallsargindex). See also [Asynchronous calls](#asynchronous-calls).

#### `stub.yieldsAsync([arg1, arg2, ...]);`
##### `stub.callsArgOnAsync(index, context);`

Same as their corresponding non-Async counterparts, but with callback being deferred (executed not immediately but after short timeout and in another "thread")
Async version of [stub.callsArgOn(index, context)](#stubcallsargonindex-context). See also [Asynchronous calls](#asynchronous-calls).

#### `stub.yieldsOnAsync(context, [arg1, arg2, ...]);`
##### `stub.callsArgWithAsync(index, arg1, arg2, ...);`

#### `stub.yieldsToAsync(property, [arg1, arg2, ...]);`
Async version of [stub.callsArgWith(index, arg1, arg2, ...)](#stubcallsargwithindex-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

#### `stub.yieldsToOnAsync(property, context, [arg1, arg2, ...])`
##### `stub.callsArgOnWithAsync(index, context, arg1, arg2, ...);`

Async version of [stub.callsArgOnWith(index, context, arg1, arg2, ...)](#stubcallsargonwithindex-context-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

##### `stub.yieldsAsync([arg1, arg2, ...]);`

Async version of [stub.yields([arg1, arg2, ...])](#stubyieldsarg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

##### `stub.yieldsOnAsync(context, [arg1, arg2, ...]);`

Async version of [stub.yieldsOn(context, [arg1, arg2, ...])](#stubyieldsoncontext-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

##### `stub.yieldsToAsync(property, [arg1, arg2, ...]);`

Async version of [stub.yieldsTo(property, [arg1, arg2, ...])](#stubyieldstoproperty-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

##### `stub.yieldsToOnAsync(property, context, [arg1, arg2, ...])`

Async version of [stub.yieldsToOn(property, context, [arg1, arg2, ...])](#stubyieldstoonproperty-context-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

#### `sinon.addBehavior(name, fn);`

Expand Down
44 changes: 33 additions & 11 deletions docs/release-source/release/stubs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,28 +458,50 @@ Useful if a function is called with more than one callback, and simply calling t

Like `callArg`, but with arguments.

#### Asynchronous calls

#### `stub.callsArgAsync(index);`
Same as their corresponding non-Async counterparts, but with callback being deferred at called after all instructions in the current call stack are processed.

Same as their corresponding non-Async counterparts, but with callback being deferred (executed not immediately but after short timeout and in another "thread")
* In Node environment the callback is deferred with `process.nextTick`.
* In a browser the callback is deferred with `setTimeout(callback, 0)`.

#### `stub.callsArgAsync(index);`
More information:

#### `stub.callsArgOnAsync(index, context);`
* <https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick>,
* <https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop>,
* <https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout>.

#### `stub.callsArgWithAsync(index, arg1, arg2, ...);`
##### `stub.callsArgAsync(index);`

#### `stub.callsArgOnWithAsync(index, context, arg1, arg2, ...);`
Async version of [stub.callsArg(index)](#stubcallsargindex). See also [Asynchronous calls](#asynchronous-calls).

#### `stub.yieldsAsync([arg1, arg2, ...]);`
##### `stub.callsArgOnAsync(index, context);`

Same as their corresponding non-Async counterparts, but with callback being deferred (executed not immediately but after short timeout and in another "thread")
Async version of [stub.callsArgOn(index, context)](#stubcallsargonindex-context). See also [Asynchronous calls](#asynchronous-calls).

#### `stub.yieldsOnAsync(context, [arg1, arg2, ...]);`
##### `stub.callsArgWithAsync(index, arg1, arg2, ...);`

#### `stub.yieldsToAsync(property, [arg1, arg2, ...]);`
Async version of [stub.callsArgWith(index, arg1, arg2, ...)](#stubcallsargwithindex-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

#### `stub.yieldsToOnAsync(property, context, [arg1, arg2, ...])`
##### `stub.callsArgOnWithAsync(index, context, arg1, arg2, ...);`

Async version of [stub.callsArgOnWith(index, context, arg1, arg2, ...)](#stubcallsargonwithindex-context-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

##### `stub.yieldsAsync([arg1, arg2, ...]);`

Async version of [stub.yields([arg1, arg2, ...])](#stubyieldsarg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

##### `stub.yieldsOnAsync(context, [arg1, arg2, ...]);`

Async version of [stub.yieldsOn(context, [arg1, arg2, ...])](#stubyieldsoncontext-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

##### `stub.yieldsToAsync(property, [arg1, arg2, ...]);`

Async version of [stub.yieldsTo(property, [arg1, arg2, ...])](#stubyieldstoproperty-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

##### `stub.yieldsToOnAsync(property, context, [arg1, arg2, ...])`

Async version of [stub.yieldsToOn(property, context, [arg1, arg2, ...])](#stubyieldstoonproperty-context-arg1-arg2-). See also [Asynchronous calls](#asynchronous-calls).

#### `sinon.addBehavior(name, fn);`

Expand Down