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

docs(Collection): Adjust exists documentation (#1876)

Browse Source 
Since the return value of Collection#exists is basically just a boolean of Collection#find's result, the same documentation and arguments can and should be applied.
This commit is contained in:
Robin B
2017-09-03 12:00:36 +02:00
committed by Crawl
parent 39013b1242
commit efbde07650
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/util/Collection.js
View File

@@ -238,19 +238,23 @@ class Collection extends Map {
/**
* Searches for the existence of a single item where its specified property's value is identical to the given value
* (`item[prop] === value`).
* (`item[prop] === value`), or the given function returns a truthy value.
* <warn>Do not use this to check for an item by its ID. Instead, use `collection.has(id)`. See
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has) for details.</warn>
* @param {string} prop The property to test against
* @param {*} value The expected value
* @param {string|Function} propOrFn The property to test against, or the function to test with
* @param {*} [value] The expected value - only applicable and required if using a property for the first argument
* @returns {boolean}
* @example
* if (collection.exists('username', 'Bob')) {
* console.log('user here!');
* }
* @example
* if (collection.exists(user => user.username === 'Bob')) {
* console.log('user here!');
* }
*/
exists(prop, value) {
return Boolean(this.find(prop, value));
exists(propOrFn, value) {
return Boolean(this.find(propOrFn, value));
}
/**