Global

Methods

assign(obj, key, value) → {object|array}

Source:

• key-path.js, line 194

async_(fn, expireopt) → {function}

Source:

• function.js, line 163

const fn = async_(async () => {})

const a = fn()
const b = fn()

a === b // the same Promise

calculate(exp, decimalopt) → {string}

Source:

• number.js, line 683

caseby(entries)

Source:

• syntax.js, line 14

clearNum00(input) → {string}

Source:

• number.js, line 88

clone(obj) → {T}

Source:

• object.js, line 10

compareby(a, b) → {number}

Source:

• number.js, line 606

compArray(a, b) → {Array.<any>}

Source:

• array.js, line 45

compute_(fn, expireopt) → {function}

Source:

• function.js, line 18

const compute = compute_((x, y) => {
  return x + y
})

// the following two computing will call original fn only once
const a = compute(1, 3)
const b = compute(1, 3)

compute.clear() // clear all cache

createArray(value, countopt) → {Array.<T>}

Source:

• array.js, line 9

createDate(datetime, givenFormatteropt) → {Date}

Source:

• date.js, line 207

createProxy(origin, options) → {any}

Source:

• object.js, line 1176

const some = {
  body: {
    hand: true,
    foot: true,
  },
}
const a = createProxy(some, {
  get(keyPath, value) {
    if (keyPath.join('.') === 'body.hand') {
      return value.toString()
    }
    else {
      return value
    }
  },
  set(keyPath, value) {},
  dispatch(keyPath, next, current) {},
})

a !== some // proxy object !== object
a.body !== some.body // proxy object !== object
a.body.hand !== some.body.hand // true !== 'true'
a.body.foot == some.body.foot // true == true

a.body.hand = false // now a.body.hand is 'false', a string
some.body.hand === false // some.body.hand changes to false

createRandomString(len, charSetopt) → {string}

Source:

• string.js, line 120

createReactive(origin, options) → {object|array}

Source:

• object.js, line 571

const some = {
  body: {
    hand: true,
    foot: true,
  },
}
const a = createReactive(some, {
  get(keyPath, value) {
    if (keyPath.join('.') === 'body.hand') {
      return value.toString()
    }
    else {
      return value
    }
  },
  set(keyPath, value) {},
  dispatch({
    keyPath,
    value, // receive value
    input, // getter output
    next, // created reactive
    prev, // current reactive
  }, force) {},
})

a !== some // reactive object !== object
a.body !== some.body // reactive object !== object
a.body.hand !== some.body.hand // true !== 'true'
a.body.foot == some.body.foot // true == true

a.body.hand = false // now a.body.hand is 'false', a string
some.body.hand === false // original data changed

createSafeExp(exp) → {string}

Source:

• regexp.js, line 5

debounce(fn, wait, immediateopt) → {function}

Source:

• timeout.js, line 8

decideby(decide, …args)

Source:

• syntax.js, line 6

define(obj, key, descriptor) → {object}

Source:

• object.js, line 272

diffArray(a, b) → {Array.<any>}

Source:

• array.js, line 36

divideby(a, b, decimalopt) → {string}

Source:

• number.js, line 443

each(obj, fn, descriptoropt) → {object|array}

Source:

• object.js, line 331

enumerify(input) → {string}

Source:

• number.js, line 34

extend(obj1, obj2, mixArropt) → {object}

Source:

• object.js, line 49

extract(obj, keys) → {object}

Deprecated:

• use pick instead

Source:

• object.js, line 480

filter(obj, fn) → {object}

Source:

• object.js, line 383

find(obj, fn) → {string}

Source:

• object.js, line 465

fixNum(input, decimalopt, padopt, flooropt) → {string}

Source:

• number.js, line 931

flat(obj, determineopt) → {object}

Source:

• object.js, line 300

flatArray(arr) → {Array.<any>}

Source:

• array.js, line 121

formatDate(datetime, formatter, givenFormatteropt) → {string}

Source:

• date.js, line 280

formatNum(input, separator, count, formatdecimalopt) → {string}

Source:

• number.js, line 1030

formatNum1000(input, formatdecimalopt) → {string}

Source:

• number.js, line 1079

formatString(input, separator, segments, alignrightopt) → {string}

Source:

• string.js, line 19

freeze(o) → {object}

Source:

• object.js, line 504

fromEntries(entries, kv) → {object}

Source:

• object.js, line 1831

get_(fn, typeopt) → {function}

Source:

• function.js, line 107

const get = get_(() => {
  return Math.random()
})

// the following two getting will call original fn only once
const a = get()
const b = get()
a === b

// type: 1
const getter = get_(() => Date.now(), 1)
const e = getter()
Promise.then(() => {
  const h = getter()
  e !== h // cache is released in a previous Promise microtask
})
setTimeout(() => {
  const f = getter()
  e !== f // when type is 1, the cache will be release in a Promise microtask, so when we call setTimeout, cache is gone
})

// type: 2
const use = get_(() => Date.now(), 2)
const m = use()
Promise.then(() => {
  const n = use()
  m === n // when type is 2, the cache will be release in a setTimeout task, so when we call in a Promise.then, cache is existing
})
setTimeout(() => {
  const l = use()
  m !== l // cache was released in a previous setTimeout task
})

getConstructorOf(ins) → {any}

Source:

• class.js, line 8

getObjectHash(obj) → {number}

Source:

• object.js, line 256

getStringHash(str) → {number}

Source:

• string.js, line 104

getSymbolContent(symb) → {string}

Source:

• object.js, line 1807

groupArray(arr, count) → {Array.<array>}

Source:

• array.js, line 136

hasOwnKey(obj, key, enumerableopt) → {boolean}

Source:

• is.js, line 440

inArray(item, arr) → {boolean}

Source:

• is.js, line 453

inherit(Parent, proptotypes, statics) → {any}

Source:

• class.js, line 19

inObject(key, obj, ownopt) → {boolean}

Source:

• is.js, line 418

interArray(a, b) → {Array.<any>}

Source:

• array.js, line 27

interpolate(template, data, optsopt) → {string}

Source:

• string.js, line 136

invoke_(fn, countopt, expireopt) → {function}

Source:

• function.js, line 233

const invoke = invoke_(() => {
  return Math.random()
}, 2)

const a = invoke()
const b = invoke()
const c = invoke()

a === b
a !== c

isAllInArray(items, arr) → {boolean}

Source:

• is.js, line 526

isArray(value) → {boolean}

Source:

• is.js, line 39

isArrayInArray(shortArr, longArr) → {boolean}

Source:

• is.js, line 537

isBlob(value) → {boolean}

Source:

• is.js, line 127

isBoolean(value) → {boolean}

Source:

• is.js, line 111

isConstructor(f, strictopt) → {boolean}

Source:

• is.js, line 199

isDate(value) → {boolean}

Source:

• is.js, line 55

isEmpty(value) → {boolean}

Source:

• is.js, line 161

isEqual(val1, val2) → {boolean}

Source:

• is.js, line 285

isFalsy(value) → {boolean}

Source:

• is.js, line 276

isFile(value) → {boolean}

Source:

• is.js, line 140

isFinite(value) → {boolean}

Source:

• is.js, line 95

isFormData(value) → {boolean}

Source:

• is.js, line 153

isFunction(value, isStrictopt) → {boolean}

Source:

• is.js, line 181

isGt(a, b) → {boolean}

Source:

• is.js, line 345

isGte(a, b) → {boolean}

Source:

• is.js, line 354

isInfinite(value) → {boolean}

Source:

• is.js, line 103

isInheritedOf(SubConstructor, Constructor, isStrictopt) → {boolean}

Source:

• is.js, line 395

isInstanceOf(value, Constructor, isStrictopt) → {boolean}

Source:

• is.js, line 377

isLt(a, b) → {boolean}

Source:

• is.js, line 327

isLte(a, b) → {boolean}

Source:

• is.js, line 336

isNaN(value) → {boolean}

Source:

• is.js, line 79

isNone(value) → {boolean}

Source:

• is.js, line 31

isNull(value) → {boolean}

Source:

• is.js, line 15

isNullish(value) → {boolean}

Source:

• is.js, line 23

isNumber(value) → {boolean}

Source:

• is.js, line 71

isNumeric(value) → {boolean}

Source:

• is.js, line 119

isObject(value) → {boolean}

Source:

• is.js, line 47

isOneInArray(items, arr) → {boolean}

Source:

• is.js, line 516

isPromise(value) → {boolean}

Source:

• is.js, line 362

isProxy(value) → {boolean}

Source:

• object.js, line 1789

isShallowEqual(objA, objB, deepthopt) → {boolean}

Source:

• is.js, line 463

isString(value) → {boolean}

Source:

• is.js, line 63

isSymbol(value) → {boolean}

Source:

• is.js, line 87

isTruthy(value) → {boolean}

Source:

• is.js, line 268

isUndefined(value) → {boolean}

Source:

• is.js, line 7

iterate(obj, fn)

Source:

• object.js, line 404

joinArray(arr, join) → {Array.<any>}

Source:

• array.js, line 176

keyin(key, obj, enumerableopt) → {boolean}

Source:

• key-path.js, line 279

makeKey(keyPath) → {string}

Source:

• key-path.js, line 87

makeKeyChain(path, isStrictopt) → {array}

Source:

• key-path.js, line 13

makeKeyPath(chain, isStrictopt) → {string}

Source:

• key-path.js, line 44

map(obj, fn) → {object}

Source:

• object.js, line 365

matchAll(regexp, str) → {array}

Source:

• regexp.js, line 19

merge(obj1, obj2, mixArropt) → {object}

Source:

• object.js, line 129

minusby(a, b) → {string}

Source:

• number.js, line 201

mixin(Source, Extend)

Source:

• class.js, line 55

multiplyby(a, b) → {string}

Source:

• number.js, line 320

num10To(num, base) → {string}

Source:

• number.js, line 1091

num10to36(num) → {string}

Source:

• number.js, line 1145

num10to62(num) → {string}

Source:

• number.js, line 1129

num36to10(code) → {number}

Source:

• number.js, line 1153

num62to10(code) → {number}

Source:

• number.js, line 1137

numerify(num) → {string}

Source:

• number.js, line 8

numTo10(code, base) → {number}

Source:

• number.js, line 1113

padLeft(str, len, pad) → {string}

Source:

• string.js, line 72

padRight(str, len, pad) → {string}

Source:

• string.js, line 89

parse(obj, key)

Source:

• key-path.js, line 98

parseAs(obj, key)

Source:

• key-path.js, line 142

var a = { a: 1, b: 2, c: 3 };
var b = parseAs(a, 'b'); // -> { b: 2 }

pick(obj, keys) → {object}

Source:

• object.js, line 489

pipe_(…fns) → {function}

Source:

• function.js, line 296

const pipe = pipe_(
  x => x + 1,
  x => x - 1,
  x => x * x,
  x => x / x,
)

const y = pipe(10) // 10

plusby(a, b) → {string}

Source:

• number.js, line 107

refineProxy(obj) → {any}

Source:

• object.js, line 1798

remove(obj, key) → {object|array}

Source:

• key-path.js, line 242

search(obj, fn) → {any}

Source:

• object.js, line 436

sortArray(items, byopt, decsopt) → {Array.<any>}

Source:

• array.js, line 87

splitArray(arr, splitter) → {Array.<array>}

Source:

• array.js, line 153

stringify(obj) → {string}

Source:

• object.js, line 189

throttle(fn, wait, immediateopt) → {function}

Source:

• timeout.js, line 36

toArray(arr) → {Array.<any>}

Source:

• array.js, line 113

toEntries(obj) → {Array.<array>}

Source:

• object.js, line 1820

unionArray(a, b) → {Array.<any>}

Source:

• array.js, line 18

uniqueArray(arr, propopt) → {Array.<any>}

Source:

• array.js, line 56

Type Definitions

KeyPath

Source:

• key-path.js, line 1