Как оформить комментарий к методу, возвращающий промис?

Question

[Святослав Хусамов]

Как оформить комментарий?
По правилам надо написать так:

/**
	 * Проверка файла. Возвращает true в промисе, если файл изменен.
	 * @return {Promise} 
	 */
	checkPageFileChangeTime() {
		let me = this;
		return new Promise((resolve, reject) => {
			if (!me._ctime) return resolve(true);
			fs.stat(me._filename, (err, stats) => {
				if (err) reject(err); else resolve(me._ctime < stats.ctime);
			});
		});
	}

Но неплохо было указать тип данных, которые вернуться в промисе, в данном случае Boolean. И возможно название данных, например isChanged.

Answer 1

[napa3um]

https://github.com/jsdoc3/jsdoc/issues/509

Answer 2

[Захар Орлов]

Тип данных можно так указать: @return {Promise<boolean>}