src/administrative-sdk/choice-challenge/choice-challenge.js

/**
 * ChoiceChallenge domain model.
 */
export default class ChoiceChallenge {
  /**
   * Create a choice challenge domain model.
   *
   * @param {?string} id - The {@link ChoiceChallenge} identifier. If none is given, one is generated.
   * @param {?string} question - A hint or question related to the choices.
   * @param {string[]} choices - The sentences of which at most one may be recognised.
   * @throws {Error} id parameter of type "string|null" is required.
   * @throws {Error} question parameter of type "string|null|undefined" is required.
   * @throws {Error} choices parameter of type "Array.<string>" is required.
   */
  constructor(id = null, question = null, choices) {
    if (id !== null && typeof id !== 'string') {
      throw new Error(
        'id parameter of type "string|null" is required');
    }

    if (question !== null && typeof question !== 'string') {
      throw new Error(
        'question parameter of type "string|null" is required');
    }

    if (!Array.isArray(choices)) {
      throw new Error(
        'choices parameter of type "Array.<string>" is required');
    }

    /**
     * The choice challenge identifier.
     * @type {string}
     */
    this.id = id;

    /**
     * A hint or question related to the choices.
     * @type {string}
     */
    this.question = question;

    /**
     * The sentences of which at most one may be recognised.
     * @type {string[]}
     */
    this.choices = choices;

    /**
     * The status of the challenge's preparation. Either 'unprepared', 'preparing' or 'prepared'.
     * @type {string}
     */
    this.status = null;
  }
}