Corrected some docstrings (#1611)

* corrected some docstrings

* merge master

* fixed MessageSearchResult typedef and moved the note for the hit property to there
This commit is contained in:
SpaceEEC
2017-07-04 00:22:48 +02:00
committed by Crawl
parent 2eb3720001
commit 3da95d7e68
3 changed files with 5 additions and 8 deletions

View File

@@ -31,8 +31,9 @@ const { TypeError } = require('../../errors');
/**
* @typedef {Object} MessageSearchResult
* @type {number} total Total result count
* @type {Array<Message[]>} results Array of message results
* @property {number} total Total result count
* @property {Array<Message[]>} results Array of message results
* The message which has triggered the result will have the `hit` property set to `true`
*/
module.exports = function search(target, options) {