Package Exports

@xcmats/js-toolbox

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@xcmats/js-toolbox) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

js-toolbox

Useful JavaScript utilities.

$ npm i @xcmats/js-toolbox

Works in node.js and browser environments (use WebPack or Rollup to bundle it with your project).

documentation

API Reference

play in your browser

RunKit with @xcmats/js-toolbox

list member functions (link):

var jsToolbox = require("@xcmats/js-toolbox")

Object.keys(jsToolbox).sort()

[ "Y",
"access",
"array",
"asciiLetters",
"asciiLowercase",
"asciiUppercase",
"async",
"asyncMap",
"asyncReduce",
"asyncRepeat",
"average",
"b64dec",
"b64enc",
... ]

play with shuffle and range (link):

jsToolbox.shuffle(jsToolbox.range(16))

[ 14, 12, 15, 8, 13, 4, 5, 6, 1, 7, 10, 0, 2, 3, 9, 11 ]

do all other things shown in examples section below

use the package

install

$ mkdir playground
$ cd playground/
$ npm init
...
$ npm i @xcmats/js-toolbox
...

play in node.js

$ node
>

> t = require("@xcmats/js-toolbox")
{ ...
array:
 { ... },
...
utils:
 { ... } }

example use in your source code

import {
    array,
    codec,
    func,
    string,
} from "@xcmats/js-toolbox"

const b64stringify = func.compose(
    codec.stringToB64, JSON.stringify
)

let stupidIdea = b64stringify({
    tenNumbers: array.range(10),
    randomLetters: string.random(20)
})

console.log(
    "Stringified and b64-encoded object: ",
    stupidIdea
)

use the source

$ git clone git@github.com:drmats/js-toolbox.git
Cloning into 'js-toolbox'...
$ cd js-toolbox
$ npm i
$ npm start
Compiling for 'commonjs' ...
🎉  Successfully compiled 10 files with Babel.
>

namespaces

If you're experimenting via RunKit then prepend all namespaces with "jsToolbox." and if you're experimenting inside node.js console with npm package (as described above) then prepend all namespaces with "t.". If you're using the source and have launched node.js session via npm start then you're good to go ( ¯\_(ツ)_/¯ ).

array utilities:

> array
{ countBy: [Function: countBy],
draw: [Function: draw],
findDuplicates: [Function: findDuplicates],
flatten: [Function: flatten],
head: [Function: head],
init: [Function: init],
last: [Function: last],
range: [Function: range],
shuffle: [Function: shuffle],
sparse: [Function: sparse],
tail: [Function: tail] }

asynchronous programming helpers:

> async
{ delay: [Function: delay],
interval: [Function: interval],
map: [Function: map],
parMap: [Function: parMap],
reduce: [Function: reduce],
repeat: [Function: repeat],
timeout: [Function: timeout] }

TypedArray coders/decoders:

> codec
{ concatBytes: [Function: concatBytes],
compareBytes: [Function: compareBytes],
stringToBytes: [Function],
bytesToString: [Function],
hexToBytes: [Function: hexToBytes],
bytesToHex: [Function: bytesToHex],
b64dec: [Function],
b64enc: [Function],
b64ToString: [Function],
stringToB64: [Function],
b64ToHex: [Function],
hexToB64: [Function] }

functional programming:

> func
{ compose: [Function: compose],
curry: [Function: curry],
partial: [Function: partial],
Y: [Function: Y] }

simple math:

> math
{ average: [Function: average],
clamp: [Function: clamp],
log10: [Function: log10],
log2: [Function: log2],
roundIfClose: [Function: roundIfClose],
sum: [Function: sum] }

some goodies for redux:

> redux
{ createReducer: [Function: createReducer] }

string utilities:

> string
{ asciiLetters: [Function: asciiLetters],
asciiLowercase: [Function: asciiLowercase],
asciiUppercase: [Function: asciiUppercase],
big: [Function],
camelToPascal: [Function: camelToPascal],
camelToSnake: [Function: camelToSnake],
capitalize: [Function: capitalize],
digits: [Function: digits],
ellipsis: { [Function: ellipsis] BEGIN: 0, MIDDLE: 1, END: 2 },
empty: [Function: empty],
space: [Function: space],
padLeft: [Function: padLeft],
padRight: [Function: padRight],
pascalToCamel: [Function: pascalToCamel],
pascalToSnake: [Function: pascalToSnake],
quote: [Function: quote],
random: [Function: random],
shorten: { [Function: shorten] BEGIN: 0, MIDDLE: 1, END: 2 },
snakeToCamel: [Function: snakeToCamel],
snakeToPascal: [Function: snakeToPascal],
wrap: [Function: wrap] }

type helpers:

> type
{ isFunction: [Function: isFunction],
isNumber: [Function: isNumber],
isObject: [Function: isObject],
isString: [Function: isString],
maxInt: 9007199254740991,
minInt: -9007199254740991,
nullToUndefined: [Function: nullToUndefined],
toBool: [Function: toBool] }

uncategorized utilities:

> utils
{ access: [Function: access],
choose: [Function: choose],
clone: [Function: clone],
dict: [Function: dict],
handleException: [Function: handleException],
identity: [Function: identity],
isBrowser: [Function: isBrowser],
objectMap: [Function: objectMap],
objectReduce: [Function: objectReduce],
randomInt: [Function: randomInt],
swap: [Function: swap],
timeUnit: { ... } }

examples

array manipulation

Find the lenghts of the words in a given sentence and count how many of them exists in each length group.

array.countBy(
    'exemplo plus quam ratione vivimus'.split(' '),
    (w) => w.length
)

{ '4': 2, '7': 3 }

Choose a random element from a given array (or a random character from a given string).
```
array.draw(string.asciiLetters())
```
```
'S'
```

Find duplicates in a given array.

array.findDuplicates(['one', 'two', 'one', 'six', 'two', 'two'])

[ 'one', 'two' ]

Flatten passed array, i.e. transform [[1, 2,], ..., [3, 4,],] to [1, 2, ..., 3, 4,].

array.flatten(Object.entries({ a: 'b', c: 'd', e: 'f' }))

[ 'a', 'b', 'c', 'd', 'e', 'f' ]

Return a list containing an arithmetic progression. range(i, j) returns [i, i+1, i+2, ..., j-1]. Possible invocations are: range(stop), range(start, stop), range(start, stop, step). When start is omitted it defaults to 0. When step is given, it specifies the increment (or decrement).
```
array.range(10)
```
```
[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ]
```
```
array.range(-128, -256, -16)
```
```
[ -128, -144, -160, -176, -192, -208, -224, -240 ]
```
Randomly shuffle all elements in the given array (Durstenfeld's modification to the Fisher-Yates shuffle algorithm). The operation is taken in-place.
```
array.shuffle(array.range(12))
```
```
[ 9, 7, 0, 8, 2, 10, 3, 1, 11, 4, 5, 6 ]
```
Generate sparse array of distinct integers. sparse(stop, size) returns array of size distinct integers in range [0..stop-1]. sparse(start, stop, size) returns array of size distinct integers in range [start..stop-1].
```
array.sparse(1024, 8)
```
```
[ 6, 34, 170, 422, 530, 643, 855, 862 ]
```

asynchronous helpers

Delay current async execution by time miliseconds.

(async () => {
    await async.delay()
    console.log('Hello ...')
    await async.delay()
    console.log('... world')
})()

Promise { <pending> }
Hello ...
... world

Invoke a sequence of asynchronous operations on an array of elements.

(async () => {
    let x = await async.map(
        array.range(10),
        (x) => async.timeout(() => {
            console.log(4*x);
            return 4*x;
        }, array.head(array.sparse(1000, 1)))
    )
    console.log(`Result: ${x}`)
})()

Promise { <pending> }
0
4
8
12
16
20
24
28
32
36
Result: 0,4,8,12,16,20,24,28,32,36

Paralelly execute operation on each element of the array.

(async () => {
    let x = await async.parMap(
        array.range(10),
        (x) => async.timeout(() => {
            console.log(4*x);
            return 4*x;
        }, array.head(array.sparse(1000, 1)))
    )
    console.log(`Result: ${x}`)
})()

Promise { <pending> }
24
8
16
12
28
20
0
36
32
4
Result: 0,4,8,12,16,20,24,28,32,36

Accumulate value over an array of elements using asynchronous operation.

(async () => {
    let x = await async.reduce(
        array.range(10),
        (acc, x) => async.timeout(() => {
            console.log(acc+x);
            return acc+x;
        }, 100*x)
    )
    console.log(`Accumulated value: ${x}`)
})()

Promise { <pending> }
0
1
3
6
10
15
21
28
36
45
Accumulated value: 45

base64 encoding and decoding

Convert UTF-8 string into an array of bytes.

codec.stringToBytes('Koń: 🐎')

Uint8Array [ 75, 111, 197, 132, 58, 32, 240, 159, 144, 142 ]

Convert array of bytes into a UTF-8 string.

data = Uint8Array.from([70, 111, 120, 58, 32, 240, 159, 166, 138])

Uint8Array [ 70, 111, 120, 58, 32, 240, 159, 166, 138 ]

codec.bytesToString(data)

'Fox: 🦊'

Encode given byte array to Base64. Base64 encoding in browser and node.js.

data = Uint8Array.from([240, 159, 142, 169, 240, 159, 144, 176])

Uint8Array [ 240, 159, 142, 169, 240, 159, 144, 176 ]

codec.b64enc(data)

'8J+OqfCfkLA='

Decode given Base64 string to byte array. Base64 decoding in browser and node.js.

data = codec.b64dec('8J+OqfCfkLA=')

Uint8Array [ 240, 159, 142, 169, 240, 159, 144, 176 ]

codec.bytesToString(data)

'🎩🐰'

hex encoding and decoding

Convert hex-encoded string to a byte representation.

codec.hexToBytes('cabafa87')

Uint8Array [ 202, 186, 250, 135 ]

codec.hexToBytes('0x1234567890ABCDEF')

Uint8Array [ 18, 52, 86, 120, 144, 171, 205, 239 ]

Convert byte representation to a hex-encoded string.

codec.bytesToHex(Uint8Array.from([31, 63, 127, 255]))

'1f3f7fff'

byte array manipulation

Concatenate contents of a given byte arrays.

codec.concatBytes(
    Uint8Array.from([255, 255, 0, 0]),
    codec.stringToBytes('🌍'),
    Uint8Array.from([128, 64])
)

Uint8Array [ 255, 255, 0, 0, 240, 159, 140, 141, 128, 64 ]

Compare two byte arrays.

codec.compareBytes(
    codec.stringToBytes('𝓬𝓸𝓭𝓮'.normalize('NFC')),
    codec.stringToBytes('𝐜𝐨𝐝𝐞'.normalize('NFC'))
)

false

codec.compareBytes(codec.hexToBytes('0xFF'), Uint8Array.from([255]))

true

functional programming

Function composition.

shortenAndQuote = func.compose(string.quote, string.shorten)

[Function]

shortenAndQuote(
    "When I find myself in times of trouble",
    20, string.shorten.END
)

'"When I find myself …"'

stringToHex = func.compose(codec.bytesToHex, codec.stringToBytes)

[Function]

stringToHex('Kaboom! 💥')

'4b61626f6f6d2120f09f92a5'

hexToString = func.compose(codec.bytesToString, codec.hexToBytes)

[Function]

hexToString('4b61626f6f6d2120f09f92a5')

'Kaboom! 💥'

Translate the evaluation of function f taking multiple arguments into an evaluation of sequence of functions, each with a single argument.
```
sum = (...args) => math.sum(args)
```
```
[Function: sum]
```
```
func.curry(sum)(1)(2)(3)(4)(5)()
```
```
15
```

Y-combinator - returns fixed point of a higher-order function passed as f. Anonymous recursion in Javascript.

factorial = func.Y((r) => (n) => n <= 0  ?  1  :  n * r(n - 1))

[Function]

factorial(5)

simple math

Compute mathematical average of array of numbers.
```
math.average([1, 2, 3, 4, 5])
```
```
3
```
Base 2 logarithm.
```
math.log2(2**32)
```
```
32
```
Base 10 logarithm.
```
math.log10(1e9)
```
```
9
```
Sum of numbers in passed array.
```
math.sum([5, 6, 7, 8, 9, 10])
```
```
45
```

operations on strings

Allocate a big string (of size 2^n).

string.big(5)

'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

Convert camelText to snake_text.

string.camelToSnake('someNightsIStayUpCashingInMyBadLuck')

'some_nights_i_stay_up_cashing_in_my_bad_luck'

Quote text.
```
string.quote('div', '<>')
```
```
'<div>'
```
Construct random string of desired length.
```
string.random(16)
```
```
'MxWGe8MoOss0yUAP'
```

Shorten a given string to the desired length.

string.shorten('abcdefghijklmnopqrstuvwxyz', 15)

'abcdefg…tuvwxyz'

string.shorten(
    'To be, or not to be, that is the question',
    20,
    string.shorten.END
)

'To be, or not to be…'

Convert snake_text to camelText.

string.snakeToCamel('some_nights_i_call_it_a_draw')

'someNightsICallItADraw'

type primitives

Determine if a given value is a proper Number (not NaN and not Infinity).

type.isNumber(NaN)

false

type.isNumber(-Infinity)

false

type.isNumber(1234.5678)

true

Determine if a given value is an Object (not null, not undefined and not Array).
```
type.isObject(null)
```
```
false
```
```
type.isObject([])
```
```
false
```
```
type.isObject({})
```
```
true
```

assorted utilities

Apply path to an object.

utils.access({ a: { b: { c: 42 } } }, ['a', 'b', 'c'])

Construct Object from the result of Object.entries() call. entries = [[k1, v1,], ..., [kn, vn,]]
```
utils.dict([['a', 'b'], ['c', 'd'], ['e', 'f']])
```
```
{ a: 'b', c: 'd', e: 'f' }
```

Shallow map (iteration) on objects.

utils.objectMap(
    { what: 'od', i: '?rof dnats' },
    ([k, v,]) => [
        string.capitalize(k),
        v.split('').reverse().join('')
    ]
)

{ What: 'do', I: 'stand for?' }

Swap keys with values in a given Object.

utils.swap({ a: 'b', c: 'd', e: 'f' })

{ b: 'a', d: 'c', f: 'e' }

notes

This library is suitable to use in server and browser environments and it is being used as such. Go ahead and file an issue if you found a bug 🐞.

license

js-toolbox is released under the Apache License, Version 2.0. See the LICENSE for more details.