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

Also deprecate the expected and actual properties of ThrowUnlessFailure

Browse Source
This commit is contained in:
Steve Gravrock
2024-10-05 13:55:49 -07:00
parent c6fa55bfc8
commit 9ccf2ef96b
2 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1430,11 +1430,18 @@ getJasmineRequireObj().Env = function(j$) {
* @description Represents a failure of an expectation evaluated with * @description Represents a failure of an expectation evaluated with
* {@link throwUnless}. Properties of this error are a subset of the * {@link throwUnless}. Properties of this error are a subset of the
* properties of {@link ExpectationResult} and have the same values. * properties of {@link ExpectationResult} and have the same values.
*
* 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.
*
* @property {String} matcherName - The name of the matcher that was executed for this expectation. * @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} message - The failure message for the expectation.
* @property {Boolean} passed - Whether the expectation passed or failed. * @property {Boolean} passed - Whether the expectation passed or failed.
* @property {Object} expected - If the expectation failed, what was the expected value. * @property {Object} expected - Deprecated. If the expectation failed, what was the expected value.
* @property {Object} actual - If the expectation failed, what actual value was produced. * @property {Object} actual - Deprecated. If the expectation failed, what actual value was produced.
*/ */
const error = new Error(result.message); const error = new Error(result.message);
error.passed = result.passed; error.passed = result.passed;

11
src/core/Env.js
View File

@@ -273,11 +273,18 @@ getJasmineRequireObj().Env = function(j$) {
* @description Represents a failure of an expectation evaluated with * @description Represents a failure of an expectation evaluated with
* {@link throwUnless}. Properties of this error are a subset of the * {@link throwUnless}. Properties of this error are a subset of the
* properties of {@link ExpectationResult} and have the same values. * properties of {@link ExpectationResult} and have the same values.
*
* 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.
*
* @property {String} matcherName - The name of the matcher that was executed for this expectation. * @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} message - The failure message for the expectation.
* @property {Boolean} passed - Whether the expectation passed or failed. * @property {Boolean} passed - Whether the expectation passed or failed.
* @property {Object} expected - If the expectation failed, what was the expected value. * @property {Object} expected - Deprecated. If the expectation failed, what was the expected value.
* @property {Object} actual - If the expectation failed, what actual value was produced. * @property {Object} actual - Deprecated. If the expectation failed, what actual value was produced.
*/ */
const error = new Error(result.message); const error = new Error(result.message);
error.passed = result.passed; error.passed = result.passed;