a-toolbox

a-toolbox

javascript lightweight basic tools, isomorphic

Purpose

"This is my rifle. There are many others like it, but this one is mine."

Install

npm i a-toolbox --save

Quick start

const tools = require('a-toolbox')

tools.string.trim('({cut these brackets please)}', ['{', '}', '(', ')'])
// > 'cut these brackets please'

modular import

const tools = {
  string: require('a-toolbox/string'),
  fs: require('a-toolbox/fs')
}

On browser

<script src="node_modules/a-toolbox/dist/atoolbox.min.js"></script>
<script>
var data = {
  name: 'Alice',
  year: 2014,
  color: 'purple'
};

var str = '<div>My name is {name} I was born in {year} and my favourite color is {color}</div>{nothing}';
console.log('template:', tools.string.template(str, data));

//> template: <div>My name is Alice I was born in 2014 and my favourite color is purple</div>{nothing}
</script>

API

documentation in progress

• array
• fs
• hash
• util
• object
• random
• string
• sys
• task
• time

fs

fs.exists(path)

• path <string> file path
• return: Promise.<boolean> true if file exists - and it's a file

replace deprecated fs.exists

Example

tools.fs.exists('/tmp/file')
// > true

fs.touch(path)

• path <string> file path
• return: Promise.<void>

create an empty file if not exists

Example

tools.fs.touch('/tmp/touch-me')

fs.unlink(path, [safe=true])

• path <string> file path
• [safe=true] <boolean> if safe do not throw exception
• return: Promise.<void>

delete file, optionally in safe mode

Example

tools.fs.unlink('/tmp/file')

---

array

array.remove(array, item)

• array <Array<*>>
• item <*>

remove an element from array\nit removes only the first occurrence

Example

let a = ['js','ruby','python']
tools.array.remove(a, 'ruby')
// > a = ['js','python']

array.removeAt(array, index)

• array <Array<*>>
• index <number>

remove an element from array at position

Example

let a = [1,2,3]
tools.array.removeAt(a, 0)
// > a = [2,3]

array.last(array)

• array <Array<*>>
• return: * last element of the array or undefined

get last element of array or undefined

Example

tools.array.last([1,2,3])
// > 3

array.at(array)

• array <Array<*>>
• return: * nth element of array; if negative, start from end: -1 = last element; undefined if missing

get nth element of array

Example

tools.array.at([1,2,3], 0)
// > 1

array.first(array)

• array <Array<*>>
• return: * first element of the array or undefined

get first element of array or undefined

Example

tools.array.first([1,2,3])
// > 1

array.contains(array, item)

• array <Array<*>>
• item <*>
• return: boolean

check if array contains an element

Example

tools.array.contains([1,2,3], 1)
// > true

array.insert(array, index, item)

• array <Array<*>>
• index <number>
• item <*>

insert an item into array at index position

Example

let a = ['john','alice','bob']
tools.array.insert(a, 0, 'mary')
// > a = ['mary', 'john', 'alice', 'bob']

array.concat(arrays)

• arrays <...Array<*>> to chain
• return: Array<*> chained arrays

concat arrays

Example

tools.array.concat([0,1,2],[3,4,5])
// > [0,1,2,3,4,5]

array.empty()

empty array - need to keep references

Example

let a = [0,1,2]
tools.array.empty(a)
// > a = []

array.add(array, item, [unique=false])

• array <Array<*>>
• item <*>
• [unique=false] <boolean>

push item into array, optionally check if already exists

Example

let a = [0,1,2,3]
tools.array.add(a, 3, true)
// > a = [0,1,2,3]

---

hash

hash.sha256(data)

• data <string> any string
• return: string sha256 in hex format

Generate hash using sha256 in hex format

Example

tools.hash.sha256('usk6fgbuygbu6')
// > 'ee42f619919727584b66fe25248ed4bba8e87dcfb3e62a90143ea17ba48df58e'

---

util

util.isSet(val)

• val <*>
• return: bool

check if val is setted, means it's not null or undefined

util.onBrowser()

• return: bool

check if you are on browser or not

---

Changelog

v. 1.2.0

• use hash.js instead of crypto

v. 1.0.0

• general review
• modular loader
• browser version

---

TODO

• doc (readme, api)
• tdd via tollo
• keywords in github and package.json

---

License

The MIT License (MIT)

Copyright (c) 2015-2018, braces lab

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.