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

@@ -406,7 +406,7 @@ class Guild {
/**
* Fetch all webhooks for the guild.
* @returns {Collection<Snowflake, Webhook>}
* @returns {Promise<Collection<Snowflake, Webhook>>}
*/
fetchWebhooks() {
return this.client.api.guilds[this.id].webhooks.get().then(data => {
@@ -418,7 +418,7 @@ class Guild {
/**
* Fetch available voice regions.
* @returns {Collection<string, VoiceRegion>}
* @returns {Promise<Collection<string, VoiceRegion>>}
*/
fetchVoiceRegions() {
return this.client.api.guilds[this.id].regions.get().then(res => {
@@ -539,8 +539,6 @@ class Guild {
* <warn>This is only available when using a user account.</warn>
* @param {MessageSearchOptions} [options={}] Options to pass to the search
* @returns {Promise<MessageSearchResult>}
* An array containing arrays of messages. Each inner array is a search context cluster.
* The message which has triggered the result will have the `hit` property set to `true`.
* @example
* guild.search({
* content: 'discord.js',

View File

@@ -203,8 +203,6 @@ class TextBasedChannel {
* <warn>This is only available when using a user account.</warn>
* @param {MessageSearchOptions} [options={}] Options to pass to the search
* @returns {Promise<MessageSearchResult>}
* An array containing arrays of messages. Each inner array is a search context cluster
* The message which has triggered the result will have the `hit` property set to `true`
* @example
* channel.search({
* content: 'discord.js',

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) {