StringUtils.js

  1. import { randomPick } from './ArrayUtils'
  2. /**
  3.  * @module StringUtils
  4. */
  5. /**
  6.  * @function generateRandom
  7.  * @description Generate a random string from a number of character and a pool of 
  8.  * @param {Number} [l=6] string length
  9.  * @param {String[]} pool possible characters to generate the string
  10.  * 
  11.  * @returns {String}
  12. */
  13. export const generateRandom = (l = 6, pool) => {
  15.     if (typeof l != 'number')
  16.         return;
  18.     if (!pool || !Array.isArray(pool) || pool.length == 0)
  19.         pool = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789$*#&!'.split('');
  21.     let s = '';
  23.     for (let i = 0; i < l; i++) {
  24.         s += randomPick(pool);
  25.     }
  27.     return s;
  29. }
  30. /**
  31.  * @function capitalize
  32.  * @description turn first character of a string to uppercase
  33.  * @param {String} s 
  34. */
  35. export const capitalize = s => {
  36.     return s && s[0].toUpperCase() + s.slice(1);
  37. }
  38. /**
  39.  * @function unCapitalize
  40.  * @description turn first character of a string to lowercase
  41.  * @param {String} s 
  42.  * 
  43.  * @returns {String}
  44. */
  45. export const unCapitalize = s => {
  46.     return s && s[0].toLowerCase() + s.slice(1);
  47. }
  48. /**
  49.  * @function capitalizeWords
  50.  * @description turn each word first letter to uppercase
  51.  * @param {String} s string to transform
  52.  * 
  53.  * @returns {String} 
  54. */
  55. export const capitalizeWords = s => {
  56.     return s.split(' ').map(s => capitalize(s)).join(' ');
  57. }
  58. /**
  59.  * @function replaceAll
  60.  * @description replace all occurrences of a search with a replacement in a String
  61.  * @param {String} str
  62.  * @param {String} search
  63.  * @param {String} replacement
  64.  * 
  65.  * @returns {String}
  66. */
  67. export const replaceAll = (str, search, replacement) => {
  68.     return str.replace(new RegExp(search, 'g'), replacement);
  69. }
  70. /**
  71.  * @function stringToFunction
  72.  * @description Returns a function from a string property path
  73.  * @param {String} str
  74.  * @returns {Function} function 
  75.  * @example
  76.  * //returns addEventListener
  77.  *  stringToFunction("window.addEventListener");
  78. */
  79. export const stringToFunction = str => {
  80.     let arr = str.split("."),
  81.         fn = (global || this);
  82.     for (let i = 0, len = arr.length; i < len; i++) {
  83.         fn = fn[arr[i]];
  84.     }
  85.     if (typeof fn !== "function") {
  86.         throw new TypeError("function not found");
  87.     }
  88.     return fn;
  89. }
  90. /**
  91.  * @function secsToMin
  92.  * @description transform a number in seconds in a string
  93.  * 
  94.  * @param {Number} d Seconds integer
  95.  * 
  96.  * @return {String} string in format hh:mm:ss
  97. */
  98. export const secsToMin = d => {
  99.     let hrs = ~~(d / 3600);
  100.     let mins = ~~((d % 3600) / 60);
  101.     let secs = ~~d % 60;
  103.     // Output like "1:01" or "4:03:59" or "123:03:59"
  104.     let ret = "";
  106.     if (hrs > 0) {
  107.         ret += "" + hrs + ":" + (mins < 10 ? "0" : "");
  108.     }
  110.     ret += "" + mins + ":" + (secs < 10 ? "0" : "");
  111.     ret += "" + secs;
  112.     return ret;
  114. }
  115. /**
  116.  * @function nFormatter
  117.  * @description format a number in counterpart unit
  118.  * @param {Number} num number to transform
  119.  * @param {Number} [digits=0] number of decimal digits
  120.  * @example
  121.  * //returns "10M"
  122.  * nFormatter(10000000)
  123. */
  124. export const nFormatter = (num, digits = 0) => {
  125.     const si = [
  126.         { value: 1, symbol: "" },
  127.         { value: 1E3, symbol: "k" },
  128.         { value: 1E6, symbol: "M" },
  129.         { value: 1E9, symbol: "G" },
  130.         { value: 1E12, symbol: "T" },
  131.         { value: 1E15, symbol: "P" },
  132.         { value: 1E18, symbol: "E" }
  133.     ];
  134.     const rx = /\.0+$|(\.[0-9]*[1-9])0+$/;
  135.     let i;
  136.     for (i = si.length - 1; i > 0; i--) {
  137.         if (num >= si[i].value) {
  138.             break;
  139.         }
  140.     }
  141.     return (num / si[i].value).toFixed(digits).replace(rx, "$1") + si[i].symbol;
  142. }
  143. /**
  144.  * @function encodeHTML
  145.  * @description replace characters like chevrons in html string
  146.  * 
  147.  * @param {String} s 
  148.  * 
  149.  * @returns {String} 
  150. */
  151. export const encodeHTML = s => {
  152.     return typeof s == 'string' 
  153.         ? s
  154.             .replace(/&/g, '&amp;')
  155.             .replace(/</g, '&lt;')
  156.             .replace(/"/g, '&quot;') 
  157.         : s;
  158. }
  160. /**
  161.  * @function generateHexKey
  162.  * @description code date timestamp in hexadecimal string
  163.  * 
  164.  * @returns {String}
  165.  * @example
  166.  * // current time: 1590247414800
  167.  * // returns "1724221dc10"
  168.  * generateHexKey()
  169. */
  170. export const generateHexKey = () => String((new Date).getTime().toString(16))
  172. export default {
  173.     capitalize,
  174.     capitalizeWords,
  175.     generateRandom,
  176.     replaceAll,
  177.     secsToMin,
  178.     stringToFunction,
  179.     unCapitalize,
  180.     nFormatter,
  181.     encodeHTML,
  182.     generateHexKey,
  183. }