QUnit.onUncaughtException()

version added: 2.17.0.

Description

QUnit.onUncaughtException( error )

Report a global error that should result in a failed test run.

This method can be safely called at any time, including between or outside tests. It is designed for use by plugins and integration layers.

In general, you should not use this method and instead throw an error. QUnit automatically finds and reports uncaught errors. The following are handled by default and should not be connected to QUnit.onUncaughtException() a second time:

• Browser Runner: window.onerror
• Browser Runner: window.addEventListener('unhandledrejection', …)
• QUnit CLI: process.on('unhandledRejection', …)
• QUnit CLI: process.on('uncaughtException', …)

When QUnit receives report of a global error strictly inside a test (or one of its module hooks), the exception is reported to the currently running test as extra failed assertion, and thus the test will be marked as failed. This means that uncaught exceptions (such as calling an undefined function) during QUnit.test.todo callback count as expected failure and not fail the test run.

Errors received before tests (e.g. early event callbacks), internally between tests, or around the runEnd event (if the process is still alive for some reason), are emitted as an “error” event to reporters.

Examples

const error = new Error('Failed to reverse the polarity of the neutron flow');
QUnit.onUncaughtException(error);

process.on('unhandledExample', QUnit.onUncaughtException);

window.addEventListener('unhandledexample', function (event) {
  QUnit.onUncaughtException(event.reason);
});