Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-15 11:03:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

add nsfw option to search (#1534)

Browse Source 
* Update Search.js

* Update TextBasedChannel.js

* Update Search.js
This commit is contained in:
Gus Caplan
2017-05-29 08:19:31 -05:00
committed by Crawl
parent 22e8237bf1
commit 1aa2293ebf
2 changed files with 29 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
src/structures/interfaces/TextBasedChannel.js
View File

@@ -199,33 +199,6 @@ class TextBasedChannel {
}); });
} }
/**
* @typedef {Object} MessageSearchOptions
* @property {string} [content] Message content
* @property {Snowflake} [maxID] Maximum ID for the filter
* @property {Snowflake} [minID] Minimum ID for the filter
* @property {string} [has] One of `link`, `embed`, `file`, `video`, `image`, or `sound`,
* or add `-` to negate (e.g. `-file`)
* @property {ChannelResolvable} [channel] Channel to limit search to (only for guild search endpoint)
* @property {UserResolvable} [author] Author to limit search
* @property {string} [authorType] One of `user`, `bot`, `webhook`, or add `-` to negate (e.g. `-webhook`)
* @property {string} [sortBy='recent'] `recent` or `relevant`
* @property {string} [sortOrder='desc'] `asc` or `desc`
* @property {number} [contextSize=2] How many messages to get around the matched message (0 to 2)
* @property {number} [limit=25] Maximum number of results to get (1 to 25)
* @property {number} [offset=0] Offset the "pages" of results (since you can only see 25 at a time)
* @property {UserResolvable} [mentions] Mentioned user filter
* @property {boolean} [mentionsEveryone] If everyone is mentioned
* @property {string} [linkHostname] Filter links by hostname
* @property {string} [embedProvider] The name of an embed provider
* @property {string} [embedType] one of `image`, `video`, `url`, `rich`
* @property {string} [attachmentFilename] The name of an attachment
* @property {string} [attachmentExtension] The extension of an attachment
* @property {Date} [before] Date to find messages before
* @property {Date} [after] Date to find messages before
* @property {Date} [during] Date to find messages during (range of date to date + 24 hours)
*/
/** /**
* Performs a search within the channel. * Performs a search within the channel.
* <warn>This is only available when using a user account.</warn> * <warn>This is only available when using a user account.</warn>

29
src/structures/shared/Search.js
View File

@@ -1,5 +1,33 @@
const long = require('long'); const long = require('long');
/**
* @typedef {Object} MessageSearchOptions
* @property {string} [content] Message content
* @property {Snowflake} [maxID] Maximum ID for the filter
* @property {Snowflake} [minID] Minimum ID for the filter
* @property {string} [has] One of `link`, `embed`, `file`, `video`, `image`, or `sound`,
* or add `-` to negate (e.g. `-file`)
* @property {ChannelResolvable} [channel] Channel to limit search to (only for guild search endpoint)
* @property {UserResolvable} [author] Author to limit search
* @property {string} [authorType] One of `user`, `bot`, `webhook`, or add `-` to negate (e.g. `-webhook`)
* @property {string} [sortBy='recent'] `recent` or `relevant`
* @property {string} [sortOrder='desc'] `asc` or `desc`
* @property {number} [contextSize=2] How many messages to get around the matched message (0 to 2)
* @property {number} [limit=25] Maximum number of results to get (1 to 25)
* @property {number} [offset=0] Offset the "pages" of results (since you can only see 25 at a time)
* @property {UserResolvable} [mentions] Mentioned user filter
* @property {boolean} [mentionsEveryone] If everyone is mentioned
* @property {string} [linkHostname] Filter links by hostname
* @property {string} [embedProvider] The name of an embed provider
* @property {string} [embedType] one of `image`, `video`, `url`, `rich`
* @property {string} [attachmentFilename] The name of an attachment
* @property {string} [attachmentExtension] The extension of an attachment
* @property {Date} [before] Date to find messages before
* @property {Date} [after] Date to find messages before
* @property {Date} [during] Date to find messages during (range of date to date + 24 hours)
* @property {boolean} [nsfw=false] Include results from NSFW channels
*/
module.exports = function search(target, options) { module.exports = function search(target, options) {
if (typeof options === 'string') options = { content: options }; if (typeof options === 'string') options = { content: options };
if (options.before) { if (options.before) {
@@ -39,6 +67,7 @@ module.exports = function search(target, options) {
embed_type: options.embedType, embed_type: options.embedType,
attachment_filename: options.attachmentFilename, attachment_filename: options.attachmentFilename,
attachment_extension: options.attachmentExtension, attachment_extension: options.attachmentExtension,
include_nsfw: options.nsfw,
}; };
// Lazy load these because some of them use util // Lazy load these because some of them use util