Document fake timer *Async() methods

[dominykas]

Purpose (TL;DR) - mandatory

Adds documentation for new lolex features, introduced in sinonjs/fake-timers#105 (and its 2019 version: sinonjs/fake-timers#237)

This needs to stay a draft until the relevant functionality from lolex is merged, but feedback is most welcome.

How to verify - mandatory

https://github.com/sinonjs/sinon/blob/master/docs/CONTRIBUTING.md

Checklist for author

• npm run lint passes
• References to standard library functions are cached.

[coveralls]

Pull Request Test Coverage Report for Build 2912

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 94.186%

---

Totals
Change from base Build 2911:	0.0%
Covered Lines:	1660
Relevant Lines:	1729

---

💛 - Coveralls

[mroderick]

Very nice!

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[dominykas]

I still have to make an update to this based on sinonjs/fake-timers#237 (comment)

[fatso83]

This is great. Thank you for doing this.

As stated in sinonjs/fake-timers#237, it would be nice with a little caveat on what to expect from runAllAsync, but it's not a blocker.

[dominykas]

As stated in sinonjs/fake-timers#237, it would be nice with a little caveat on what to expect from runAllAsync, but it's not a blocker.

See sinonjs/fake-timers#237 (comment)

[fatso83]

As soon as we bump the version number for Lolex and the version used in Sinon, I guess we should merge this. Right?

[dominykas]

Yeah, I suppose so. Not sure what's the release process here. Possibly this can be merged into whatever PR does the Lolex bumping?

[dominykas]

sinon@8 is now out - this can probably now get merged?

[mroderick]

@dominykas thanks! Once we cut the next release, this will be visible on the site.