typhonjs-escomplex-commons/src/module/traits/TraitUtil.js

Provides core common utilities for typhonjs-escomplex modules and plugins.

/**
 * TraitUtil
 */
export default class TraitUtil
{
   /**
    * Provides safe array creation from a given input.
    *
    * @param {*}  value - A value to potentially convert into a safe array.
    *
    * @returns {Array}
    */
   static safeArray(value)
   {
      return typeof value === 'undefined' || value === null ? [] : Array.isArray(value) ? value : [value];
   }

   /**
    * Provides a utility method that defers to `object.name` if it exists or fallback to `defaultName` or `anonymous`.
    *
    * @param {object}   object - The target object to provide safe name coverage.
    * @param {string}   defaultName - A default name to fallback to if `object.name` is missing.
    *
    * @returns {string}
    */
   static safeName(object, defaultName = '')
   {
      if (object !== null && typeof object === 'object' && typeof object.name === 'string' && object.name !== '')
      {
         return object.name;
      }

      if (typeof defaultName === 'string' && defaultName !== '') { return defaultName; }

      return '<anonymous>';
   }

   /**
    * Provides a utility method that defers to `object.value` if it exists or fallback to `defaultValue` or `anonymous`.
    *
    * @param {object}   object - The target object to provide safe name coverage.
    * @param {string}   defaultValue - A default value to fallback to if `object.value` is missing.
    *
    * @returns {string}
    */
   static safeValue(object, defaultValue = '')
   {
      if (object !== null && typeof object === 'object' && typeof object.value === 'string' && object.value !== '')
      {
         return object.value;
      }

      if (typeof defaultValue === 'string' && defaultValue !== '') { return defaultValue; }

      return '<anonymous>';
   }
}