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

Deprecate the expected and actual properties of expectation results

Browse Source
This commit is contained in:
Steve Gravrock
2024-10-04 07:54:20 -07:00
parent 71f6a95ce5
commit 40f402d117
5 changed files with 36 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/core/buildExpectationResult.js
View File

@@ -4,13 +4,21 @@ getJasmineRequireObj().buildExpectationResult = function(j$) {
const exceptionFormatter = new j$.ExceptionFormatter();
/**
* @typedef Expectation
* Describes the result of evaluating an expectation
*
* Note: The expected and actual properties are deprecated and may be removed
* in a future release. In many Jasmine configurations they are passed
* through JSON serialization and deserialization, which is inherently
* lossy. In such cases, the expected and actual values may be placeholders
* or approximations of the original objects.
*
* @typedef ExpectationResult
* @property {String} matcherName - The name of the matcher that was executed for this expectation.
* @property {String} message - The failure message for the expectation.
* @property {String} stack - The stack trace for the failure if available.
* @property {Boolean} passed - Whether the expectation passed or failed.
* @property {Object} expected - If the expectation failed, what was the expected value.
* @property {Object} actual - If the expectation failed, what actual value was produced.
* @property {Object} expected - Deprecated. If the expectation failed, what was the expected value.
* @property {Object} actual - Deprecated. If the expectation failed, what actual value was produced.
* @property {String|undefined} globalErrorType - The type of an error that
* is reported on the top suite. Valid values are undefined, "afterAll",
* "load", "lateExpectation", and "lateError".