Added jsdocs for asymmetric equality testers
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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}
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user