discord.js/src/structures/Typing.js

'use strict';

const Base = require('./Base');

/**
 * Represents a typing state for a user in a channel.
 * @extends {Base}
 */
class Typing extends Base {
  /**
   * @param {TextBasedChannels} channel The channel this typing came from
   * @param {User} user The user that started typing
   * @param {APITypingStart} data The raw data received
   */
  constructor(channel, user, data) {
    super(channel.client);

    /**
     * The channel the status is from
     * @type {TextBasedChannels}
     */
    this.channel = channel;

    /**
     * The user who is typing
     * @type {User}
     */
    this.user = user;

    this._patch(data);
  }

  _patch(data) {
    /**
     * The UNIX timestamp in milliseconds the user started typing at
     * @type {number}
     */
    this.startedTimestamp = data.timestamp * 1000;
  }

  /**
   * Indicates whether the status is received from a guild.
   * @returns {boolean}
   */
  inGuild() {
    return this.guild !== null;
  }

  /**
   * The time the user started typing at
   * @type {Date}
   * @readonly
   */
  get startedAt() {
    return new Date(this.startedTimestamp);
  }

  /**
   * The guild the status is from
   * @type {?Guild}
   * @readonly
   */
  get guild() {
    return this.channel.guild ?? null;
  }

  /**
   * The member who is typing
   * @type {?GuildMember}
   * @readonly
   */
  get member() {
    return this.guild?.members.resolve(this.user) ?? null;
  }
}

module.exports = Typing;

/**
 * @external APITypingStart
 * @see {@link https://discord.com/developers/docs/topics/gateway#typing-start-typing-start-event-fields}
 */