Added jsdocs for asymmetric equality testers

This commit is contained in:
Steve Gravrock
2021-06-21 14:09:14 -07:00
parent 095745ab12
commit 1893bf6c16
2 changed files with 50 additions and 0 deletions

View File

@@ -5388,6 +5388,31 @@ getJasmineRequireObj().MatchersUtil = function(j$) {
return MatchersUtil;
};
/**
* @interface AsymmetricEqualityTester
* @classdesc An asymmetric equality tester is an object that can match multiple
* objects. Examples include jasmine.any() and jasmine.stringMatching().
* User-defined asymmetric equality testers can also be defined and used in
* expectations.
* @see custom_asymmetric_equality_testers
* @since 2.0.0
*/
/**
* Determines whether a value matches this tester
* @function
* @name AsymmetricEqualityTester#asymmetricMatch
* @param value {any} The value to test
* @param matchersUtil {MatchersUtil} utilities for testing equality, etc
* @return {Boolean}
*/
/**
* Returns a string representation of this tester to use in matcher failure messages
* @function
* @name AsymmetricEqualityTester#jasmineToString
* @param pp {function} Function that takes a value and returns a pretty-printed representation
* @return {String}
*/
getJasmineRequireObj().MismatchTree = function(j$) {
/*
To be able to apply custom object formatters at all possible levels of an

View File

@@ -655,3 +655,28 @@ getJasmineRequireObj().MatchersUtil = function(j$) {
return MatchersUtil;
};
/**
* @interface AsymmetricEqualityTester
* @classdesc An asymmetric equality tester is an object that can match multiple
* objects. Examples include jasmine.any() and jasmine.stringMatching().
* User-defined asymmetric equality testers can also be defined and used in
* expectations.
* @see custom_asymmetric_equality_testers
* @since 2.0.0
*/
/**
* Determines whether a value matches this tester
* @function
* @name AsymmetricEqualityTester#asymmetricMatch
* @param value {any} The value to test
* @param matchersUtil {MatchersUtil} utilities for testing equality, etc
* @return {Boolean}
*/
/**
* Returns a string representation of this tester to use in matcher failure messages
* @function
* @name AsymmetricEqualityTester#jasmineToString
* @param pp {function} Function that takes a value and returns a pretty-printed representation
* @return {String}
*/