SchemaDate types not matching jsdoc types / accepted types

[hasezoey]

Do you want to request a feature or report a bug?
types

What is the current behavior?
SchemaDate jsdoc & examples list that accepted types are Number | String

mongoose/lib/schema/date.js

Lines 118 to 157 in 80245ed

	/**
	* Declares a TTL index (rounded to the nearest second) for _Date_ types only.
	*
	* This sets the `expireAfterSeconds` index option available in MongoDB >= 2.1.2.
	* This index type is only compatible with Date types.
	*
	* ####Example:
	*
	* // expire in 24 hours
	* new Schema({ createdAt: { type: Date, expires: 60*60*24 }});
	*
	* `expires` utilizes the `ms` module from [guille](https://github.com/guille/) allowing us to use a friendlier syntax:
	*
	* ####Example:
	*
	* // expire in 24 hours
	* new Schema({ createdAt: { type: Date, expires: '24h' }});
	*
	* // expire in 1.5 hours
	* new Schema({ createdAt: { type: Date, expires: '1.5h' }});
	*
	* // expire in 7 days
	* const schema = new Schema({ createdAt: Date });
	* schema.path('createdAt').expires('7d');
	*
	* @param {Number|String} when
	* @added 3.0.0
	* @return {SchemaType} this
	* @api public
	*/
	SchemaDate.prototype.expires = function(when) {
	if (!this._index || this._index.constructor.name !== 'Object') {
	this._index = {};
	}
	this._index.expires = when;
	utils.expires(this._index);
	return this;
	};

but types say its number | Date (not number | string)

mongoose/index.d.ts

Lines 1660 to 1661 in c36bd64

	/** Defines a TTL index on this path. Only allowed for dates. */
	expires?: number | NativeDate;

What are the versions of Node.js, Mongoose and MongoDB you are using? Note that "latest" is not a version.
mongoose 5.13.5

---

PS: is it correct to not include SchemaDate (and others) in the documentation? there i could only find SchemaDateOptions under API (and SchemaDateOptions does not have the examples / accepted types from SchemaDate)

[vkarpov15]

Re: including SchemaDate in documentation, that's worth discussing more. We explicitly exclude them because we don't want to imply that users should be creating SchemaDate instances - most users shouldn't have to be aware of SchemaDate.