Source: lib/kss_parameter.js

  1. 'use strict';
  3. /**
  4.  * The `kss/lib/kss_parameter` module is normally accessed via the
  5.  * [`KssParameter()`]{@link module:kss.KssParameter} class of the `kss` module:
  6.  * ```
  7.  * const KssParameter = require('kss').KssParameter;
  8.  * ```
  9.  * @private
  10.  * @module kss/lib/kss_parameter
  11.  */
  13. /**
  14.  * A KssParameter object represents a single parameter of a `KssSection`.
  15.  *
  16.  * This class is normally accessed via the [`kss`]{@link module:kss} module:
  17.  * ```
  18.  * const KssParameter = require('kss').KssParameter;
  19.  * ```
  20.  *
  21.  * @alias module:kss.KssParameter
  22.  */
  23. class KssParameter {
  25.   /**
  26.    * Creates a KssParameter object and stores the given data.
  27.    *
  28.    * If passed an object, it will add `section`, `name`, and `description`
  29.    * properties.
  30.    *
  31.    * @param {Object} [data] An object of data.
  32.    */
  33.   constructor(data) {
  34.     data = data || {};
  36.     this.meta = {
  37.       section: null
  38.     };
  40.     this.data = {
  41.       name: '',
  42.       defaultValue: '',
  43.       description: ''
  44.     };
  46.     // Loop through the given properties.
  47.     for (let name in data) {
  48.       // If the property is defined in this.data or this.meta, add it via our API.
  49.       if (data.hasOwnProperty(name) && (this.data.hasOwnProperty(name) || this.meta.hasOwnProperty(name))) {
  50.         this[name](data[name]);
  51.       }
  52.     }
  53.   }
  55.   /**
  56.    * Gets or sets the `KssSection` object this `KssParameter` is associated with.
  57.    *
  58.    * If the `section` value is provided, the `KssSection` for this parameter is
  59.    * set. Otherwise, the `KssSection` of the parameter is returned.
  60.    *
  61.    * @param {KssSection} [section] Optional. The `KssSection` that owns the
  62.    *   `KssParameter`.
  63.    * @returns {KssSection|KssParameter} If section is given, the current
  64.    *   `KssParameter` object is returned to allow chaining of methods. Otherwise,
  65.    *   the `KssSection` object the parameter belongs to is returned.
  66.    */
  67.   section(section) {
  68.     if (typeof section === 'undefined') {
  69.       return this.meta.section;
  70.     }
  72.     this.meta.section = section;
  73.     // Allow chaining.
  74.     return this;
  75.   }
  77.   /**
  78.    * Gets or sets the name of the `KssParameter`.
  79.    *
  80.    * If the `name` value is provided, the name of this `KssParameter` is set.
  81.    * Otherwise, the name of the `KssParameter` is returned.
  82.    *
  83.    * @param {string} [name] Optional. The name of the `KssParameter`.
  84.    * @returns {string|KssParameter} If name is given, the current `KssParameter`
  85.    *   object is returned to allow chaining of methods. Otherwise, the name of the
  86.    *   `KssParameter` is returned.
  87.    */
  88.   name(name) {
  89.     if (typeof name === 'undefined') {
  90.       return this.data.name;
  91.     }
  93.     this.data.name = name;
  94.     // Allow chaining.
  95.     return this;
  96.   }
  98.   /**
  99.    * Gets or sets the default value of the `KssParameter`.
  100.    *
  101.    * If the `defaultValue` value is provided, the default value of this
  102.    * `KssParameter` is set. Otherwise, the default value of the `KssParameter` is
  103.    * returned.
  104.    *
  105.    * @param {string} defaultValue Optional. The default value of the
  106.    *   `KssParameter`.
  107.    * @returns {string|KssParameter} If `defaultValue` is given, the current
  108.    *   `KssParameter` object is returned to allow chaining of methods. Otherwise,
  109.    *   the default value of the `KssParameter` is returned.
  110.    */
  111.   defaultValue(defaultValue) {
  112.     if (typeof defaultValue !== 'undefined') {
  113.       this.data.defaultValue = defaultValue;
  114.       // Allow chaining.
  115.       return this;
  116.     } else {
  117.       return this.data.defaultValue;
  118.     }
  119.   }
  121.   /**
  122.    * Gets or sets the description of the `KssParameter`.
  123.    *
  124.    * If the `description` is provided, the description of this `KssParameter` is set.
  125.    * Otherwise, the description of the `KssParameter` is returned.
  126.    *
  127.    * @param {string} [description] Optional. The description of the `KssParameter`.
  128.    * @returns {string|KssParameter} If description is given, the current
  129.    *   `KssParameter` object is returned to allow chaining of methods. Otherwise,
  130.    *   the description of the `KssParameter` is returned.
  131.    */
  132.   description(description) {
  133.     if (typeof description === 'undefined') {
  134.       return this.data.description;
  135.     }
  137.     this.data.description = description;
  138.     // Allow chaining.
  139.     return this;
  140.   }
  142.   /**
  143.    * Return the `KssParameter` as a JSON object.
  144.    *
  145.    * @returns {Object} A JSON object representation of the `KssParameter`.
  146.    */
  147.   toJSON() {
  148.     return {
  149.       name: this.name(),
  150.       defaultValue: this.defaultValue(),
  151.       description: this.description()
  152.     };
  153.   }
  154. }
  156. module.exports = KssParameter;