es-util v1.6.1

Es Utils library

es-util is a useful methods library, contain some functions we might need in a project which based on ES

Installation

npm

$ npm install es-util --save

in browser

<script src="https://cdn.jsdelivr.net/npm/es-util/lib/index.min.js"></script>

Usage

in webpack or node

import * as EsUtil from 'es-util'
// or import { xxx } from 'es-util'
// or const EsUtil = require('es-util')

// example, array2tree
const array = [
  { id: 1, pid: 0, name: 'language' },
  { id: 2, pid: 1, name: 'english' },
  { id: 3, pid: 1, name: 'chinese' }
]
console.log(EsUtil.array2tree)
/* log
[
  {
    id: 1,
    pid: 0,
    name: 'language',
    children: [
      {
        id: 2,
        pid: 1,
        name: 'english',
        children: []
      },
      {
        id: 3,
        pid: 1,
        name: 'chinese',
        children: []
      }
    ]
  }
]
*/

API

array-tree-switch module

array2tree(array, options)

transform an array to tree structure

parameters:

• array {Array} The array need to transform.
• options {Object} The options.
• options.primaryKey {String} the primary key of array item, default 'id'
• options.parentKey {String} the parent key of array item, default 'pid'
• options.childrenKey {String} the childrenKey key of tree structure node, default 'children'
• options.createRoot {Boolean/Function} whether to create a root node, default 'false', will return an array, if 'true' ,will return an object. you can pass an function as well, the transformed array will pass to function
• options.parentRefKey {Boolean/String} whether to create a reference of current node's parent, default 'false', will do nothing. if you set it to string or 'true'(mean '_parent') ,will use it as the object key which point to the parent node of current node.

  warning: set the parentRefKey will make the return tree object/array cycling, so you can't use JSON.stringify to stringify it

returns: array or object with tree structure.

Example

import { array2tree } from 'es-util'

const array = [
  { id: 1, parentId: 0, name: 'language' },
  { id: 2, parentId: 1, name: 'english' },
  { id: 3, parentId: 1, name: 'chinese' }
]

const tree = array2tree(array, {
  parentKey: 'parentId',
  childrenKey: 'nodes',
  createRoot: true
})
/* log
{
  nodes: [
    {
      id: 1,
      pid: 0,
      name: 'language',
      nodes: [
        {
          id: 2,
          pid: 1,
          name: 'english',
          nodes: []
        },
        {
          id: 3,
          pid: 1,
          name: 'chinese',
          nodes: []
        }
      ]
    }
  ]
}
*/
const tree = array2tree(array, {
  parentRefKey: true
})
/* log
[
  {
    id: 1,
    pid: 0,
    name: 'language',
    _parent: null,
    children: [
      {
        id: 2,
        pid: 1,
        name: 'english',
        children: [],
        _parent: {
          id: 1,
          pid: 0
          ...,
          _parent: ...
        }
      },
      {
        id: 3,
        pid: 1,
        name: 'chinese',
        children: [],
        _parent: {
          id: 1,
          pid: 0
          ...,
          _parent: ...
        }
      }
    ]
  }
]
*/

tree2array(tree, options)

transform tree structure to an array

parameters:

• tree {Array/Object} The tree structure need to transform.
• options {Object} The options.
• options.primaryKey {String} the primary key of node item, default 'id'
• options.parentKey {String} the parent key of node item, default 'pid'
• options.childrenKey {String} the childrenKey key of node item, default 'children'
• options.hasParentKey {Boolean} whether tree node has parent property, default 'true', if 'false' ,will add an parent key property

returns: items array

Example

import { tree2array } from 'es-util'

const tree = {
  id: 0,
  nodes: [
    {
      id: 1,
      name: 'language',
      children: [
        {
          id: 2,
          name: 'english',
          children: []
        },
        {
          id: 3,
          name: 'chinese',
          children: []
        }
      ]
    }
  ]
}

const tree = array2tree(array, {
  hasParentKey: false
})
console.log(tree)
/* log
[
  { id: 1, pid: 0, name: 'language' },
  { id: 2, pid: 1, name: 'english' },
  { id: 3, pid: 1, name: 'chinese' }
]
*/

validate module

ChinaIdCardValid(idCard)

Check whether the Chinese id number provided is valid

parameters:

• idCard {String} The IDcard number.

returns: boolean

Example

import { ChinaIdCardValid } from 'es-util'


console.log(ChinaIdCardValid('[valid IDcard]')
console.log(ChinaIdCardValid('111111111111111111')
/* log
true
false
*/

formulaValidate(formulaString, variables)

Check whether the formulaString provided is valid

parameters:

• formulaString {String} The formula string.
• variables {Array} The variables can appear in formula.

returns: boolean

Example

import { formulaValidate } from 'es-util'


console.log(formulaValidate('A+B*(D-C/E)')
console.log(formulaValidate('A+*B/E')
console.log(formulaValidate('A+*B/E', ['A', 'B', 'C'])
/* log
true
false
false
*/

object-array module

mapToObject(objectArray, keyProp, valueProp)

create an object from an object array.

parameters:

• objectArray {Array} The source object array.
• keyProp {String/Function} The property of array item be used for key, or the function to create object key, default "key".

  if array item not contain key or function not return a string/number，the item will ignore.

• valueProp {String/Function} The property of array item be used for value, or the function to create object value, default "value".

returns: object

Example

import { mapToObject } from 'es-util'

const array = [
  { key: 'a', value: 'b', name: 'afsfsdfe' },
  { key: 'a1', value: 'b1', name: 'afssdfsfe' },
  { key: 'a2', value: 'b2', name: 'afsfgege' }
]
console.log(mapToObject(array)
/* log
{ a: 'b', a1: 'b1', a2: 'b2' }
*/
console.log(mapToObject(array, item => (item.key + item.value), 'name'))
/* log
{ ab: 'afsfsdfe', a1b1: 'afssdfsfe', a2b2: 'afsfgege' }
*/

checkoutBy(object, keys, mergeFn)

checkout an array from an object by gived keys, you can merge new data to object item

parameters:

• object {Object} The source object.
• keys {Array/Object} The properties array of object. or an object contains keys which you want to pick from object and values you want to merge to those picked values. if keys not provided, will return Object.values(object)
• mergeFn {Function} this method use Object.assign to merge values where two value are object, you can provide custom function to merge value.
  • empty {Object} empty object
  • objectValue {Object} the value of objectkeyitem
  • keysValue {Object} the value of keyskeyitem

returns: array

Example

import { checkoutBy } from 'es-util'

const configs = {
  a: { key: 1, name: 'afsfsdfe' },
  b: { key: 2, name: { a: 'afssdfsfe' } },
  c: { key: 3, name: 'afsfgege' },
  d: { key: 4 }
}
console.log(checkoutBy(configs, ['a', 'c'])
/* log
[{ key: 1, name: 'afsfsdfe' }, { key: 3, name: 'afsfgege' }]
*/
console.log(checkoutBy(configs, { a: null, b: { name: { b: 'aaa' } } })
/* log
[{ key: 1, name: 'afsfsdfe' }, { key: 2, name: { b: 'aaa' } }]
*/
const { merge } = required('lodash')
console.log(checkoutBy(configs, { d: 123, b: { name: { b: 'aaa' } } }, merge)
/* log
[123, { key: 2, name: { a: 'afssdfsfe', b: 'aaa' } }]
*/

pickRenameKeys(object, keysMap)

pick and rename object's keys

parameters:

• object {Object} The source object.
• keysMap {Object} The oldKey-newKey object

returns: array

Example

import { pickRenameKeys } from 'es-util'

const configs = {
  a: { name: 'afsfsdfe' },
  b: 3,
  c: [123],
  d: 'aaa'
}
console.log(pickRenameKeys(configs, { 'a': 'a1', 'c': 'c3', 'd': 'd' })
/* log
{ a1: { name: 'afsfsdfe' }, c3: [123], d: 'aaa' }
*/

value-string-switch module

byteStringify(byteNum, options)

transform byte size to a string in the specified format

parameters:

• byteNum {Number} The size number need to transform.
• options {Object} The options.
• options.standard {String} the standard used to transform, default 'jedec', suport 'metric', 'iec'. Metric, IEC and JEDEC units
• options.unitLvl {String} the unit lvl to transform byte size, default 'auto'. suport 'B','K','M','G','T','P','E','Z','Y'
• options.precision {Number} the precision of value, default 1
• options.detail {Boolean} whether to return an object of detai info, default false.

returns: string or object

Example

import { byteStringify } from 'es-util'

byteStringify(1234)
/*log '1.2 KB'*/
byteStringify(-1234, { precision: 2 })
/*log '-1.21 KB'*/
byteStringify(1234, { unitLvl: 'M', precision: 3 })
/*log '0.001 MB'*/
byteStringify(1234, { detail: true, standard: 'metric', precision: 3 })
/*log { value: '1.234', unit: 'kB' } */

camelize(string)

camelize string

parameters:

• string {String} The string need to camelize.

returns: string

hyphenate(string)

hyphenate string

parameters:

• string {String} The string need to hyphenate.

returns: string

camel2snake(string)

switch camelize string to snake style(_)

parameters:

• string {String} The string need to switch.

returns: string

Example

import { camelize, hyphenate, camel2snake } from 'es-util'

camelize('aa-bb-cc')
camelize('aa_bb_cc')
/*log 'aaBbCc' */
hyphenate('aaBbCc')
/*log 'aa-bb-cc' */
camel2snake('aaBbCc')
/*log 'aa_bb_cc'*/

License

MIT