Fix JSDoc for createClock

This improves the generated .d.ts so that createClock may be called without arguments.
sinonjs · May 27, 2021 · cdd0391 · cdd0391
1 parent f5d9b3a
commit cdd0391
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/fake-timers-src.js b/src/fake-timers-src.js
@@ -731,8 +731,8 @@ function withGlobal(_global) {
     var originalSetTimeout = _global.setImmediate || _global.setTimeout;
 
     /**
-     * @param {Date|number} start the system time - non-integer values are floored
-     * @param {number} loopLimit maximum number of timers that will be run when calling runAll()
+     * @param {Date|number} [start] the system time - non-integer values are floored
+     * @param {number} [loopLimit] maximum number of timers that will be run when calling runAll()
      * @returns {Clock}
      */
     function createClock(start, loopLimit) {
@@ -1309,7 +1309,7 @@ function withGlobal(_global) {
     /* eslint-disable complexity */
 
     /**
-     * @param {Config=} config Optional config
+     * @param {Config=} [config] Optional config
      * @returns {Clock}
      */
     function install(config) {