Source: Preference.js

  1. // See https://github.com/jenkinsci/js-storage
  2. const storage = require('@jenkins-cd/storage');
  3. const jenkinsNS = storage.jenkinsNamespace();
  4. const preferences = jenkinsNS.subspace('preferences');
  5. /**
  6.  * This uses the localStorage to store and read from. We use a simple
  7.  * key:value in the localStorage but further expose the allowedValues
  8.  * passed. For now we do not validate those.
  9.  * @param {string} key - the key we want to store
  10.  * @param {string} [defaultValue] - if no value is set in the storage we will set this value
  11.  * @param {Array} [allowedValues] - an array of known values that should be supported
  12.  * @constructor
  13.  * @example
  14.  * preference.newPreference('key', 'defaultValue', ['defaultValue', 'allowedValues']);
  15.  */
  16. function Preference(key, defaultValue, allowedValues) {
  17.     if (key === undefined) {
  18.         throw new Error('Cannot create preference. Preference "key" name must be specified.');
  19.     }
  20.     this.key = key;
  21.     let value = preferences.get(key);
  22.     if (!value && defaultValue) {
  23.         preferences.set(key, defaultValue);
  24.         value = defaultValue;
  25.     }
  26.     this.value = value;
  27.     this.allowedValues = allowedValues;
  28. }
  30. Preference.prototype = {
  31.     /**
  32.      * setter method to set the new value for the preference
  33.      * @param newValue
  34.      */
  35.     set newValue(newValue) {
  36.         preferences.set(this.key, newValue);
  37.         this.value = newValue;
  38.     },
  39.     /**
  40.      * get the value
  41.      * @returns {*|string|Object|boolean|number|undefined}
  42.      */
  43.     getValue() {
  44.         return this.value;
  45.     },
  46.     /**
  47.      * get the known allowed values for this preference
  48.      * @returns {*}
  49.      */
  50.     getAllowedValues() {
  51.         return this.allowedValues;
  52.     }
  53. };
  54. /**
  55.  * Create a {Preference} instance for the specified key.
  56.  * @param {string} key The key name. Use dot separated naming convention to create a key hierarchy (ala Log4J).
  57.  * @param {string} [defaultValue] The default value we want to use if nothing is set
  58.  * @param {Array} [allowedValues] Array of known supported values
  59.  * @returns {Preference} The {Preference} instance.
  60.  */
  61. exports.newPreference = function (key, defaultValue, allowedValues) {
  62.     return new Preference(key, defaultValue, allowedValues);
  63. };