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

Improved jsdocs for originalFn argument to createSpy

Browse Source 
Fixes jasmine.github.io#137.
This commit is contained in:
Steve Gravrock
2023-08-14 18:31:50 -07:00
parent bfedda9764
commit c16974b091
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -8479,7 +8479,11 @@ getJasmineRequireObj().interface = function(jasmine, env) {
* @since 1.3.0 * @since 1.3.0
* @function * @function
* @param {String} [name] - Name to give the spy. This will be displayed in failure messages. * @param {String} [name] - Name to give the spy. This will be displayed in failure messages.
* @param {Function} [originalFn] - Function to act as the real implementation. * @param {Function} [originalFn] - The "real" function. This will
* be used for subsequent calls to the spy after you call
* `mySpy.and.callThrough()`. In most cases you should omit this parameter.
* The usual way to supply an original function is to call {@link spyOn}
* instead of createSpy.
* @return {Spy} * @return {Spy}
*/ */
jasmine.createSpy = function(name, originalFn) { jasmine.createSpy = function(name, originalFn) {

6
src/core/requireInterface.js
View File

@@ -423,7 +423,11 @@ getJasmineRequireObj().interface = function(jasmine, env) {
* @since 1.3.0 * @since 1.3.0
* @function * @function
* @param {String} [name] - Name to give the spy. This will be displayed in failure messages. * @param {String} [name] - Name to give the spy. This will be displayed in failure messages.
* @param {Function} [originalFn] - Function to act as the real implementation. * @param {Function} [originalFn] - The "real" function. This will
* be used for subsequent calls to the spy after you call
* `mySpy.and.callThrough()`. In most cases you should omit this parameter.
* The usual way to supply an original function is to call {@link spyOn}
* instead of createSpy.
* @return {Spy} * @return {Spy}
*/ */
jasmine.createSpy = function(name, originalFn) { jasmine.createSpy = function(name, originalFn) {