simple-squiggle

string.js (6296B)

---

 import { isBigNumber, isString, typeOf } from './is.js';
 import { format as formatNumber } from './number.js';
 import { format as formatBigNumber } from './bignumber/formatter.js';
 /**
  * Check if a text ends with a certain string.
  * @param {string} text
  * @param {string} search
  */
 
 export function endsWith(text, search) {
   var start = text.length - search.length;
   var end = text.length;
   return text.substring(start, end) === search;
 }
 /**
  * Format a value of any type into a string.
  *
  * Usage:
  *     math.format(value)
  *     math.format(value, precision)
  *     math.format(value, options)
  *
  * When value is a function:
  *
  * - When the function has a property `syntax`, it returns this
  *   syntax description.
  * - In other cases, a string `'function'` is returned.
  *
  * When `value` is an Object:
  *
  * - When the object contains a property `format` being a function, this
  *   function is invoked as `value.format(options)` and the result is returned.
  * - When the object has its own `toString` method, this method is invoked
  *   and the result is returned.
  * - In other cases the function will loop over all object properties and
  *   return JSON object notation like '{"a": 2, "b": 3}'.
  *
  * Example usage:
  *     math.format(2/7)                // '0.2857142857142857'
  *     math.format(math.pi, 3)         // '3.14'
  *     math.format(new Complex(2, 3))  // '2 + 3i'
  *     math.format('hello')            // '"hello"'
  *
  * @param {*} value             Value to be stringified
  * @param {Object | number | Function} [options]
  *     Formatting options. See src/utils/number.js:format for a
  *     description of the available options controlling number output.
  *     This generic "format" also supports the option property `truncate: NN`
  *     giving the maximum number NN of characters to return (if there would
  *     have been more, they are deleted and replaced by an ellipsis).
  * @return {string} str
  */
 
 export function format(value, options) {
   var result = _format(value, options);
 
   if (options && typeof options === 'object' && 'truncate' in options && result.length > options.truncate) {
     return result.substring(0, options.truncate - 3) + '...';
   }
 
   return result;
 }
 
 function _format(value, options) {
   if (typeof value === 'number') {
     return formatNumber(value, options);
   }
 
   if (isBigNumber(value)) {
     return formatBigNumber(value, options);
   } // note: we use unsafe duck-typing here to check for Fractions, this is
   // ok here since we're only invoking toString or concatenating its values
 
 
   if (looksLikeFraction(value)) {
     if (!options || options.fraction !== 'decimal') {
       // output as ratio, like '1/3'
       return value.s * value.n + '/' + value.d;
     } else {
       // output as decimal, like '0.(3)'
       return value.toString();
     }
   }
 
   if (Array.isArray(value)) {
     return formatArray(value, options);
   }
 
   if (isString(value)) {
     return '"' + value + '"';
   }
 
   if (typeof value === 'function') {
     return value.syntax ? String(value.syntax) : 'function';
   }
 
   if (value && typeof value === 'object') {
     if (typeof value.format === 'function') {
       return value.format(options);
     } else if (value && value.toString(options) !== {}.toString()) {
       // this object has a non-native toString method, use that one
       return value.toString(options);
     } else {
       var entries = Object.keys(value).map(key => {
         return '"' + key + '": ' + format(value[key], options);
       });
       return '{' + entries.join(', ') + '}';
     }
   }
 
   return String(value);
 }
 /**
  * Stringify a value into a string enclosed in double quotes.
  * Unescaped double quotes and backslashes inside the value are escaped.
  * @param {*} value
  * @return {string}
  */
 
 
 export function stringify(value) {
   var text = String(value);
   var escaped = '';
   var i = 0;
 
   while (i < text.length) {
     var c = text.charAt(i);
 
     if (c === '\\') {
       escaped += c;
       i++;
       c = text.charAt(i);
 
       if (c === '' || '"\\/bfnrtu'.indexOf(c) === -1) {
         escaped += '\\'; // no valid escape character -> escape it
       }
 
       escaped += c;
     } else if (c === '"') {
       escaped += '\\"';
     } else {
       escaped += c;
     }
 
     i++;
   }
 
   return '"' + escaped + '"';
 }
 /**
  * Escape special HTML characters
  * @param {*} value
  * @return {string}
  */
 
 export function escape(value) {
   var text = String(value);
   text = text.replace(/&/g, '&amp;').replace(/"/g, '&quot;').replace(/'/g, '&#39;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
   return text;
 }
 /**
  * Recursively format an n-dimensional matrix
  * Example output: "[[1, 2], [3, 4]]"
  * @param {Array} array
  * @param {Object | number | Function} [options]  Formatting options. See
  *                                                lib/utils/number:format for a
  *                                                description of the available
  *                                                options.
  * @returns {string} str
  */
 
 function formatArray(array, options) {
   if (Array.isArray(array)) {
     var str = '[';
     var len = array.length;
 
     for (var i = 0; i < len; i++) {
       if (i !== 0) {
         str += ', ';
       }
 
       str += formatArray(array[i], options);
     }
 
     str += ']';
     return str;
   } else {
     return format(array, options);
   }
 }
 /**
  * Check whether a value looks like a Fraction (unsafe duck-type check)
  * @param {*} value
  * @return {boolean}
  */
 
 
 function looksLikeFraction(value) {
   return value && typeof value === 'object' && typeof value.s === 'number' && typeof value.n === 'number' && typeof value.d === 'number' || false;
 }
 /**
  * Compare two strings
  * @param {string} x
  * @param {string} y
  * @returns {number}
  */
 
 
 export function compareText(x, y) {
   // we don't want to convert numbers to string, only accept string input
   if (!isString(x)) {
     throw new TypeError('Unexpected type of argument in function compareText ' + '(expected: string or Array or Matrix, actual: ' + typeOf(x) + ', index: 0)');
   }
 
   if (!isString(y)) {
     throw new TypeError('Unexpected type of argument in function compareText ' + '(expected: string or Array or Matrix, actual: ' + typeOf(y) + ', index: 1)');
   }
 
   return x === y ? 0 : x > y ? 1 : -1;
 }