classes/structures/member/member.js

  1. const User = require("../user/user.js");
  3. class Member {
  4.   /**
  5.    * Member constructor
  6.    * @param {Object} memberData The member data
  7.    * @param {User} memberData.user The user
  8.    * @param {Array<number>} memberData.roleIds The role ids
  9.    * @param {String | undefined} memberData.nickname The nickname of the user
  10.    * @param {Date} memberData.joinedAt The date the user joined the server
  11.    * @param {boolean | undefined} memberData.isOwner Whether the user is the owner of the server
  12.    * @param {Client} client The client instance
  13.    * @returns {Member<User, Array<number>, String | undefined, Date, boolean>} The user, the role ids, the nickname of the user, the date the user joined the server, whether the user is the owner of the server
  14.    */
  15.   constructor(memberData, client) {
  16.     /**
  17.      * The user ID
  18.      * @type {string}
  19.      * @readonly
  20.      */
  21.     this.userId = memberData.userId;
  23.     /**
  24.      * The Client instance
  25.      * @type {Client}
  26.      * @readonly
  27.      */
  28.     this.client = client;
  30.     /**
  31.      * The server ID
  32.      * @type {string}
  33.      * @readonly
  34.      */
  35.     this.serverId = memberData.serverId ?? null;
  37.     /**
  38.      * The user
  39.      * @type {User}
  40.      * @readonly
  41.      */
  42.     this.user = new User(memberData.user, client);
  44.     /**
  45.      * The role IDs
  46.      * @type {Array<number>}
  47.      * @readonly
  48.      */
  49.     this.roles = memberData.roleIds ?? [];
  51.     /**
  52.      * The nickname of the user
  53.      * @type {string}
  54.      * @readonly
  55.      */
  56.     this.nickname = memberData.nickname ?? null;
  58.     /**
  59.      * The date the user joined the server
  60.      * @type {Date}
  61.      * @readonly
  62.      */
  63.     this.joinedAt = new Date(memberData.joinedAt);
  65.     /**
  66.      * Whether the user is the owner of the server
  67.      * @type {boolean}
  68.      * @readonly
  69.      */
  70.     this.isOwner = Boolean(memberData.isOwner);
  72.     /**
  73.      * The raw member data
  74.      * @type {Object}
  75.      * @readonly
  76.      */
  77.     this.raw = memberData;
  78.   }
  79. }
  81. module.exports = Member;