Class Mentions

constructor

• new Mentions(message: MessageStruct, _users: string[]): Mentions

  Creates a new Mentions instance.

  Parameters

  • message: MessageStruct

    The message associated with the mentions.

  • _users: string[]

    An array of user IDs mentioned in the message.

  Returns Mentions

Readonlyclient

Readonlymessage

members

• get members(): Map<string, ServerMember> | null

  Retrieves the server members mentioned in the message.

  Returns Map<string, ServerMember> | null

  A map of user IDs to ServerMember instances, or null if the message is not in a server.

  Example

  const members = mentions.members;
  if (members) {
    members.forEach(member => console.log(member.displayName));
  }
  Copy

users

• get users(): Map<string, User>

  Retrieves the users mentioned in the message.

  Returns Map<string, User>

  A map of user IDs to User instances.

  Example

  const users = mentions.users;
  users.forEach(user => console.log(user.username));
  Copy

has

• has(user: UserResolvable): boolean

  Checks if a specific user is mentioned in the message.

  Parameters

  • user: UserResolvable

    The user to check.

  Returns boolean

  true if the user is mentioned, otherwise false.

  Throws

  Throws an error if the user cannot be resolved.

  Example

  if (mentions.has(someUser)) {
    console.log("User is mentioned!");
  }
  Copy