mirror of
https://github.com/danbulant/discord.js
synced 2026-05-27 22:11:53 +00:00
5c3f5d7048
* Remove GroupDMChannels they sparked no joy * Start partials for message deletion * MessageUpdate partials * Add partials as an opt-in client option * Add fetch() to Message * Message.author should never be undefined * Fix channels being the wrong type * Allow fetching channels * Refactor and add reaction add partials * Reaction remove partials * Check for emoji first * fix message fetching janky * User partials in audit logs * refactor overwrite code * guild member partials * partials as a whitelist * document GuildMember#fetch * fix: check whether a structure is a partial, not whether cache is true * typings: Updated for latest commit (#3075) * partials: fix messageUpdate behaviour (now "old" message can be partial) * partials: add warnings and docs * partials: add partials to index.yml * partials: tighten "partial" definitions * partials: fix embed-only messages counting as partials
62 lines
1.8 KiB
JavaScript
62 lines
1.8 KiB
JavaScript
'use strict';
|
|
|
|
const DataStore = require('./DataStore');
|
|
const User = require('../structures/User');
|
|
const GuildMember = require('../structures/GuildMember');
|
|
const Message = require('../structures/Message');
|
|
|
|
/**
|
|
* A data store to store User models.
|
|
* @extends {DataStore}
|
|
*/
|
|
class UserStore extends DataStore {
|
|
constructor(client, iterable) {
|
|
super(client, iterable, User);
|
|
}
|
|
|
|
/**
|
|
* Data that resolves to give a User object. This can be:
|
|
* * A User object
|
|
* * A Snowflake
|
|
* * A Message object (resolves to the message author)
|
|
* * A GuildMember object
|
|
* @typedef {User|Snowflake|Message|GuildMember} UserResolvable
|
|
*/
|
|
|
|
/**
|
|
* Resolves a UserResolvable to a User object.
|
|
* @param {UserResolvable} user The UserResolvable to identify
|
|
* @returns {?User}
|
|
*/
|
|
resolve(user) {
|
|
if (user instanceof GuildMember) return user.user;
|
|
if (user instanceof Message) return user.author;
|
|
return super.resolve(user);
|
|
}
|
|
|
|
/**
|
|
* Resolves a UserResolvable to a user ID string.
|
|
* @param {UserResolvable} user The UserResolvable to identify
|
|
* @returns {?Snowflake}
|
|
*/
|
|
resolveID(user) {
|
|
if (user instanceof GuildMember) return user.user.id;
|
|
if (user instanceof Message) return user.author.id;
|
|
return super.resolveID(user);
|
|
}
|
|
|
|
/**
|
|
* Obtains a user from Discord, or the user cache if it's already available.
|
|
* @param {Snowflake} id ID of the user
|
|
* @param {boolean} [cache=true] Whether to cache the new user object if it isn't already
|
|
* @returns {Promise<User>}
|
|
*/
|
|
async fetch(id, cache = true) {
|
|
const existing = this.get(id);
|
|
if (existing && !existing.partial) return existing;
|
|
const data = await this.client.api.users(id).get();
|
|
return this.add(data, cache);
|
|
}
|
|
}
|
|
|
|
module.exports = UserStore;
|