utils-js

Utilities for javascript development.

Usage

ESM

import * as utils from "./dist/utils.min.mjs";

CJS

const utils = require("./dist/utils.min.cjs");

Browser

<script src="./dist/utils.min.js"></script>
<script>
  const { isBoolean, } = window.utils;
</script>

Object type validations

const res = utils.isBoolean(true); // true
const res = utils.isNumber(1); // true
const res = utils.isNumeric("1"); // true
const res = utils.isString("str"); // true
const res = utils.isEmptyString(""); // true
const res = utils.isObject({ a: 1 }); // true
const res = utils.isEmptyObject({}); // true
const res = utils.isNull(null); // true
const res = utils.isArray([0, 1, 2]); // true
const res = utils.isBooleanArray([true, false]); // true
const res = utils.isNumberArray([1, 2, 3]); // true
const res = utils.isStringArray(["a", "b", "c"]); // true
const res = utils.isObjectArray([{ a: 1 }, { a: 2 }, { a: 3 }]); // true
const res = utils.isEmptyArray([]); // true
const res = utils.isFunction(isNaN); // true
const res = utils.isEmpty(undefined); // true
const res = utils.isEmpty(null); // true
const res = utils.isSameType(1, 2); // true
const res = utils.isSameType(null, null); // true

utils.getRandomNumber(min, max)

const res = utils.getRandomNumber(0, 1);
// 0 <= n < 1

utils.getBezierPoint(data, time)

const data = [[0, 0], [0.25, 1], [0.5, 1], [1, 1]];
const time = 0.5;
const res = utils.getBezierPoint(data, time);
// [ 0.40625, 0.875 ]

utils.setAnimation(data, cb, time, tick)

const data = [[0, 0], [0.25, 1], [0.5, 1], [1, 1]];
const time = 1000; // ms
const tick = 10; // ms
const res = utils.setAnimation(data, function([x, y], now, timer) {
  console.log(`${now}: ${x} ${y}`);
  // ...
  // 970: 0.9556682499999999 0.999973
  // 980: 0.970298 0.999992
  // 990: 0.9850747499999999 0.999999
  // 1000: 1 1
  
  if (!timer) {
    // end
  } else {
    // stop
    clearTimeout(timer);
  }
}, time, tick);

utils.generateObjectId()

const res = utils.generateObjectId();
// 66334bcae2c321000000

utils.generateUUID()

const res = utils.generateUUID();
// 93cbe72f-a5aa-4b31-acee-409a17c1849f

utils.encryptString(str, salt)

const str = "Lorem ipsum dolor sit amet.";
const salt = "3939";
const encrypted = utils.encryptString(str, salt);
// VA\^ZI@L^WV_VA@PGRTVM

const decrypted = utils.encryptString(encrypted, salt);
// Lorem ipsum dolor sit amet.

utils.toBase64(str, type)

const str = "Lorem ipsum dolor sit amet.";
const type = "image/jpeg"; // optional
const res = utils.toBase64(str, type);
// data:image/jpeg;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQu

utils.fromBase64(str)

const str = "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQu";
const res = utils.fromBase64(str);
// Lorem ipsum dolor sit amet.

utils.splitInt(str)

const str = "Oregano Leaves, 0.5 tsp";
const res = utils.splitInt(str);
// [ 'Oregano Leaves, ', '0', '.', '5', ' tsp' ]

utils.splitFloat(str)

const str = "Oregano Leaves, 0.5 tsp";
const res = utils.splitFloat(str);
// [ 'Oregano Leaves, ', '0.5', ' tsp' ]

utils.getExtension(path)

const str = "EPUB/styles/default.css";
const res = utils.getExtension(str);
// .css

utils.getFilename(path, ext)

const str = "EPUB/styles/default.css";
const res = utils.getFilename(str);
// default.css

const res = utils.getFilename(str, utils.getExtension(str));
// default

utils.getDirectoryPath(path)

const str = "EPUB/styles/default.css";
const res = utils.getDirectoryPath(str);
// EPUB/styles

utils.getDirectoryPath(path)

const str = "EPUB/styles/default.css";
const res = utils.getDirectoryPath(str);
// EPUB/styles

utils.getRelativePath(from, to)

const from = "META-INF/container.xml";
const to = "EPUB/styles/default.css";
const res = utils.getRelativePath(from, to);
// ../../EPUB/styles/default.css

utils.toFullWidth(str)

const str = "Lorem ipsum dolor sit amet.";
const res = utils.toFullWidth(str);
// Ｌｏｒｅｍ ｉｐｓｕｍ ｄｏｌｏｒ ｓｉｔ ａｍｅｔ．

utils.toHalfWidth(str)

const str = "Ｌｏｒｅｍ ｉｐｓｕｍ ｄｏｌｏｒ ｓｉｔ ａｍｅｔ．";
const res = utils.toHalfWidth(str);
// Lorem ipsum dolor sit amet.

utils.compareString(strA, strB)

// Compare characters.
const a = "Lorem ipsum dolor sit amet.";
const b = "Lorem ipsum foobar sit aget.";
const res = utils.compareString(a, b);
// {
//   acc: 0.8727272727272727,
//   result: [
//     { type: 0, value: 'Lorem ipsum ' },
//     { type: -1, value: 'd' },
//     { type: 1, value: 'f' },
//     { type: 0, value: 'o' },
//     { type: -1, value: 'l' },
//     { type: 0, value: 'o' },
//     { type: 1, value: 'ba' },
//     { type: 0, value: 'r sit a' },
//     { type: -1, value: 'm' },
//     { type: 1, value: 'g' },
//     { type: 0, value: 'et.' }
//   ]
// }

// Compare words.
const a = "Lorem ipsum dolor sit amet.".split(/([\s])/g);
const b = "Lorem ipsum foobar sit aget.".split(/([\s])/g);
const res = utils.compareString(a, b);
// {
//   acc: 0.7777777777777778,
//   result: [
//     { type: 0, value: 'Lorem ipsum ' },
//     { type: -1, value: 'dolor' },
//     { type: 1, value: 'foobar' },
//     { type: 0, value: ' sit ' },
//     { type: -1, value: 'amet.' },
//     { type: 1, value: 'aget.' }
//   ]
// }

utils.compareObject(a, b)

const a = "a2";
const b = "a10";
const res = utils.compareObject(a, b);
// -1

utils.parseCommand(str)

const str = "git commit -m \"update 'many' features\" -f true";
const res = utils.parseCommand(str);
// [ 'git', 'commit', '-m', "update 'many' features", '-f', 'true' ]

utils.parseQueryString(str)

const str = "https://www.google.com/search?q=bing&page=10&page=39";
const res = utils.parseQueryString(str);
// { q: [ 'bing' ], page: [ '10', '39' ] }

const str = "q=bing&page=10&page=39";
const res = utils.parseQueryString(str);
// { q: [ 'bing' ], page: [ '10', '39' ] }

utils.parseTemplate(str, obj)

const str = "${a} ${b.bb.bbb} ${c[cc]['ccc'][2]} amet.";
const obj = {
  a: "Lorem ipsum",
  b: {
    bb: {
      bbb: "dolor",
    },
  },
  c: {
    cc: {
      ccc: ["A", "B", "sit"],
    }
  } 
};
const res = utils.parseTemplate(str, obj);
// Lorem ipsum dolor sit amet.

utils.getMinValue(arr)

const arr = [1, 2, 3, 4, 5, 6];
const res = utils.getMinValue(arr);
// 1

utils.getMaxValue(arr)

const arr = [1, 2, 3, 4, 5, 6];
const res = utils.getMaxValue(arr);
// 6

utils.getMeanValue(arr)

const arr = [1, 2, 3, 4, 5, 6];
const res = utils.getMeanValue(arr);
// 3.5

utils.getModeValue(arr)

const arr = [1, 2, 3, 3, 4, 5, 6];
const res = utils.getModeValue(arr);
// 3

utils.getRandomValue(arr)

const arr = [1, 2, 3, 4, 5, 6];
const res = utils.getRandomValue(arr);
// 3

utils.createArray(len, value)

const res = utils.createArray(5, 1);
// [ 1, 1, 1, 1, 1 ]

const res = utils.createArray(5, (index) => index);
// [ 0, 1, 2, 3, 4 ]

const res = utils.createArray(5, []);
res[0].push(1);
// [ [1], [], [], [], [] ]

utils.sortArray(arr, desc)

const arr = ["a-10", "b-2", true, "b-11", "a-9", null, 1, false];
const res = utils.sortArray(arr, false);
// [null, false, true, 1, 'a-9', 'a-10', 'b-2', 'b-11']

utils.sortObject(arr, sorter)

const arr = [{
  type: "a",
  age: 10,
  height: 150,
},{
  type: "d",
  age: 13,
  height: 130,
},{
  type: "b",
  age: 12,
  height: 140,
},{
  type: "b",
  age: 11,
  height: 170,
}];
const sorter = ["type", "-age", "height"];
// const sorter = "type -age height";
const res = utils.sortObject(arr, sorter);
// [
//   { age: 10, height: 150, type: 'a' },
//   { age: 12, height: 140, type: 'b' },
//   { age: 11, height: 170, type: 'b' },
//   { age: 13, height: 130, type: 'd' }
// ]

utils.shuffleArray(arr)

const arr = [1, 2, 3, 4, 5, 6];
const res = utils.shuffleArray(arr);
// [ 5, 1, 2, 4, 6, 3 ]

utils.spreadArray(arr)

const arr = [
  [1, 2, 3],
  [4, 5, 6, 7],
  [8, 9, 10],
];

const res = utils.spreadArray(arr);
// [
//   [ 1, 4, 8 ], [ 1, 4, 9 ], [ 1, 4, 10 ],
//   [ 1, 5, 8 ], [ 1, 5, 9 ], [ 1, 5, 10 ],
//   [ 1, 6, 8 ], [ 1, 6, 9 ], [ 1, 6, 10 ],
//   [ 1, 7, 8 ], [ 1, 7, 9 ], [ 1, 7, 10 ],
//   [ 2, 4, 8 ], [ 2, 4, 9 ], [ 2, 4, 10 ],
//   [ 2, 5, 8 ], [ 2, 5, 9 ], [ 2, 5, 10 ],
//   [ 2, 6, 8 ], [ 2, 6, 9 ], [ 2, 6, 10 ],
//   [ 2, 7, 8 ], [ 2, 7, 9 ], [ 2, 7, 10 ],
//   [ 3, 4, 8 ], [ 3, 4, 9 ], [ 3, 4, 10 ],
//   [ 3, 5, 8 ], [ 3, 5, 9 ], [ 3, 5, 10 ],
//   [ 3, 6, 8 ], [ 3, 6, 9 ], [ 3, 6, 10 ],
//   [ 3, 7, 8 ], [ 3, 7, 9 ], [ 3, 7, 10 ]
// ]

utils.copyObject(obj)

const obj = {
  a: {
    b: "A",
  },
};
const clone = utils.copyObject(obj);
clone.a.b = "B";
// obj: { a: { b: "A" } }
// clone: { a: { b: "B" } }

utils.groupByKey(obj, key)

const arr = [
  { name: "john", age: 10 },
  { name: "john", age: 15 },
  { name: 1, age: 10 },
  { name: {}, age: 9 },
  { name: [], age: 9 },
  { name: true, age: 9 },
];
const key = "name";
const res = utils.groupByKey(arr, key);
// {
//   '1': [ { name: 1, age: 10 } ],
//   john: [ { name: 'john', age: 10 }, { name: 'john', age: 15 } ],
//   '[object Object]': [ { name: {}, age: 9 } ],
//   '': [ { name: [], age: 9 } ],
//   true: [ { name: true, age: 9 } ]
// }

utils.queryObject(obj, qry)

Please check MongoDB Query for more details.

const obj = {
  name: "John",
};

const qry = {
  $and: [{
    name: "John",
  }, {
    name: {
      $eq: "John",
    }
  }, {
    name: {
      $ne: "Bob",
    }
  }, {
    name: {
      $re: /^John$/
    }
  }, {
    name: {
      $exists: true,
    },
  }, {
    name: {
      $in: ["Bob", "John"],
    },
  }, {
    name: {
      $nin: ["Bob", "Mike"],
    },
  }, {
    $not: {
      name: "Bob"
    }
  }]
};

const res = utils.queryObject(obj, qry);
// true

utils.getContainedSize(src, dst)

const src = { width: 5, height: 10 };
const dst = { width: 20, height: 20 };
const res = utils.getContainedSize(src, dst);
// { width: 10, height: 20 }

utils.getCoveredSize(src, dst)

const src = { width: 5, height: 10 };
const dst = { width: 20, height: 20 };
const res = utils.getCoveredSize(src, dst);
// { width: 20, height: 40 }

utils.wait(delay)

await utils.wait(1000); // ms

utils.promiseAll(funcs)

let i = 0;
async function a() {
  return i++;
}
const funcs = [a, a, a];
const res = await utils.promiseAll(funcs);
// [0,1,2]

References

base64

shinich39/utils-js

utils-js

Usage

References