How to specify Date object in jsdoc function parameter?

Question

/**
 * 
 * @param {?} date 
 */
function diffDays (date){

  var utcThis = Date.UTC(this.getFullYear(), this.getMonth(), this.getDate(), this.getHours(), this.getMinutes(), this.getSeconds(), this.getMilliseconds());
  var utcOther = Date.UTC(date.getFullYear(), date.getMonth(), date.getDate(), date.getHours(), date.getMinutes(), date.getSeconds(), date.getMilliseconds());

  return (utcThis - utcOther) / 86400000;
};

I couldn't find any documentation about built-in Date object in jsdoc docs. What is the recommended way of specifying the Date type in params list.

score 14 · Answer 1 · answered Jul 31 '20 at 23:37

14

I wrote it like this

/**
 *  @param {Date} date - input date
 */

answered Jul 31 '20 at 23:37

hyperzlib

141
2

2

It shows type `any` in intellisense, which is not the thing I'm looking for. – suchcodemuchwow Jul 31 '20 at 23:42

How to specify Date object in jsdoc function parameter?

1 Answers1