discord.js/src/structures/LabelComponent.js

A powerful library for interacting with the Discord API

'use strict';

const Component = require('./Component');
const { createComponent } = require('../util/Components');

/**
 * Represents a label component
 *
 * @extends {Component}
 */
class LabelComponent extends Component {
  constructor({ component, ...data }) {
    super(data);

    /**
     * The component in this label
     *
     * @type {Component}
     * @readonly
     */
    this.component = createComponent(component);
  }

  /**
   * The label of the component
   *
   * @type {string}
   * @readonly
   */
  get label() {
    return this.data.label;
  }

  /**
   * The description of this component
   *
   * @type {?string}
   * @readonly
   */
  get description() {
    return this.data.description ?? null;
  }

  /**
   * Returns the API-compatible JSON for this component
   *
   * @returns {APILabelComponent}
   */
  toJSON() {
    return { ...this.data, component: this.component.toJSON() };
  }
}

module.exports = LabelComponent;