Method asActionDescription

lib/action.ts:57–75

* Get the action description. * * @returns {Object} Description of the action as an object.

()

   * @returns {Object} Description of the action as an object.
   */
  asActionDescription(): Action.ActionDescription {
    const description: Action.ActionDescription = {
      [this.name]: {
        href: this.hrefPrefix + this.href,
        timeRequested: this.timeRequested,
        status: this.status,
      },
    };

    if (this.input !== null) {
      description[this.name].input = this.input;
    }

    if (this.timeCompleted !== null) {
      description[this.name].timeCompleted = this.timeCompleted;
    }

    return description;
  }

  /**
   * Set the prefix of any hrefs associated with this action.