Files
discord.js/src/stores/GuildMemberStore.js
Isabella 45127bb408 docs: improve examples (master branch) (#2209)
* docs: improve examples

* more improvements


fix


maybe this


another example


collectors

* stuff
2018-01-04 01:12:05 +01:00

147 lines
4.9 KiB
JavaScript

const DataStore = require('./DataStore');
const GuildMember = require('../structures/GuildMember');
const { Events, OPCodes } = require('../util/Constants');
const Collection = require('../util/Collection');
const { Error } = require('../errors');
/**
* Stores guild members.
* @extends {DataStore}
*/
class GuildMemberStore extends DataStore {
constructor(guild, iterable) {
super(guild.client, iterable, GuildMember);
this.guild = guild;
}
create(data, cache) {
return super.create(data, cache, { extras: [this.guild] });
}
/**
* Data that resolves to give a GuildMember object. This can be:
* * A GuildMember object
* * A User resolvable
* @typedef {GuildMember|UserResolvable} GuildMemberResolvable
*/
/**
* Resolves a GuildMemberResolvable to a GuildMember object.
* @param {GuildMemberResolvable} member The user that is part of the guild
* @returns {?GuildMember}
*/
resolve(member) {
const memberResolveable = super.resolve(member);
if (memberResolveable) return memberResolveable;
const userResolveable = this.client.users.resolveID(member);
if (userResolveable) return super.resolve(userResolveable);
return null;
}
/**
* Resolves a GuildMemberResolvable to an member ID string.
* @param {GuildMemberResolvable} member The user that is part of the guild
* @returns {?Snowflake}
*/
resolveID(member) {
const memberResolveable = super.resolveID(member);
if (memberResolveable) return memberResolveable;
const userResolveable = this.client.users.resolveID(member);
return this.has(userResolveable) ? userResolveable : null;
}
/**
* Options used to fetch a single member from a guild.
* @typedef {Object} FetchMemberOptions
* @property {UserResolvable} user The user to fetch
* @property {boolean} [cache=true] Whether or not to cache the fetched member
*/
/**
* Options used to fetch multiple members from a guild.
* @typedef {Object} FetchMembersOptions
* @property {string} [query=''] Limit fetch to members with similar usernames
* @property {number} [limit=0] Maximum number of members to request
*/
/**
* Fetches member(s) from Discord, even if they're offline.
* @param {UserResolvable|FetchMemberOptions|FetchMembersOptions} [options] If a UserResolvable, the user to fetch.
* If undefined, fetches all members.
* If a query, it limits the results to users with similar usernames.
* @returns {Promise<GuildMember>|Promise<Collection<Snowflake, GuildMember>>}
* @example
* // Fetch all members from a guild
* guild.members.fetch()
* .then(console.log)
* .catch(console.error);
* @example
* // Fetch a single member
* guild.members.fetch('66564597481480192')
* .then(console.log)
* .catch(console.error);
* guild.members.fetch({ user, cache: false }) // Fetch and don't cache
* .then(console.log)
* .catch(console.error);
* @example
* // Fetch by query
* guild.members.fetch({ query: 'hydra' })
* .then(console.log)
* .catch(console.error);
*/
fetch(options) {
if (!options) return this._fetchMany();
const user = this.client.users.resolveID(options);
if (user) return this._fetchSingle({ user, cache: true });
if (options.user) {
options.user = this.client.users.resolveID(options.user);
if (options.user) return this._fetchSingle(options);
}
return this._fetchMany(options);
}
_fetchSingle({ user, cache }) {
const existing = this.get(user);
if (existing) return Promise.resolve(existing);
return this.client.api.guilds(this.guild.id).members(user).get()
.then(data => this.create(data, cache));
}
_fetchMany({ query = '', limit = 0 } = {}) {
return new Promise((resolve, reject) => {
if (this.guild.memberCount === this.size) {
resolve(query || limit ? new Collection() : this);
return;
}
this.guild.client.ws.send({
op: OPCodes.REQUEST_GUILD_MEMBERS,
d: {
guild_id: this.guild.id,
query,
limit,
},
});
const fetchedMembers = new Collection();
const handler = (members, guild) => {
if (guild.id !== this.guild.id) return;
for (const member of members.values()) {
if (query || limit) fetchedMembers.set(member.id, member);
}
if (this.guild.memberCount <= this.size ||
((query || limit) && members.size < 1000) ||
(limit && fetchedMembers.size >= limit)) {
this.guild.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
resolve(query || limit ? fetchedMembers : this);
}
};
this.guild.client.on(Events.GUILD_MEMBERS_CHUNK, handler);
this.guild.client.setTimeout(() => {
this.guild.client.removeListener(Events.GUILD_MEMBERS_CHUNK, handler);
reject(new Error('GUILD_MEMBERS_TIMEOUT'));
}, 120e3);
});
}
}
module.exports = GuildMemberStore;