admin/jasmine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify spyOnGlobalErrorsAsync API docs

Browse Source
This commit is contained in:
Steve Gravrock
2024-03-04 18:08:17 -08:00
parent d06dce4614
commit 1624b07589
2 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
lib/jasmine-core/jasmine.js
View File

@@ -615,10 +615,16 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) {
* rejection events asynchronously, especially in browsers. If the event * rejection events asynchronously, especially in browsers. If the event
* occurs after the promise returned from the callback is settled, it won't * occurs after the promise returned from the callback is settled, it won't
* be routed to the spy even if the underlying error occurred previously. * be routed to the spy even if the underlying error occurred previously.
* It's up to you to ensure that the returned promise isn't resolved until * It's up to you to ensure that all of the error/rejection events that you
* all of the error/rejection events that you want to handle have occurred. * want to handle have occurred before you resolve the promise returned from
* the callback.
* *
* You must await the return value of spyOnGlobalErrorsAsync. * You must ensure that the `it`/`beforeEach`/etc fn that called
* `spyOnGlobalErrorsAsync` does not signal completion until after the
* promise returned by `spyOnGlobalErrorsAsync` is resolved. Normally this is
* done by `await`ing the returned promise. Leaving the global error spy
* installed after the `it`/`beforeEach`/etc fn that installed it signals
* completion is likely to cause problems and is not supported.
* @name jasmine.spyOnGlobalErrorsAsync * @name jasmine.spyOnGlobalErrorsAsync
* @function * @function
* @async * @async

12
src/core/base.js
View File

@@ -439,10 +439,16 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) {
* rejection events asynchronously, especially in browsers. If the event * rejection events asynchronously, especially in browsers. If the event
* occurs after the promise returned from the callback is settled, it won't * occurs after the promise returned from the callback is settled, it won't
* be routed to the spy even if the underlying error occurred previously. * be routed to the spy even if the underlying error occurred previously.
* It's up to you to ensure that the returned promise isn't resolved until * It's up to you to ensure that all of the error/rejection events that you
* all of the error/rejection events that you want to handle have occurred. * want to handle have occurred before you resolve the promise returned from
* the callback.
* *
* You must await the return value of spyOnGlobalErrorsAsync. * You must ensure that the `it`/`beforeEach`/etc fn that called
* `spyOnGlobalErrorsAsync` does not signal completion until after the
* promise returned by `spyOnGlobalErrorsAsync` is resolved. Normally this is
* done by `await`ing the returned promise. Leaving the global error spy
* installed after the `it`/`beforeEach`/etc fn that installed it signals
* completion is likely to cause problems and is not supported.
* @name jasmine.spyOnGlobalErrorsAsync * @name jasmine.spyOnGlobalErrorsAsync
* @function * @function
* @async * @async