BellaJS
========

Lightweight util for handling data type, string... in your Node.js and browser apps.

!CodeQL
!CI test

Contents

* Setup
* APIs
* DataType detection
* String manipulation
* Data handling: clone, copies
* Array utils: pick, sort, sortBy, shuffle, unique
* Functional utils: curry, compose, pipe, maybe
* Date utils: formatDateString, formatTimeAgo
* Random utils: randint, genid

* Test

* License

Install & Usage

$3

``bash
npm i bellajs

pnpm

pnpm i bellajs

yarn

yarn add bellajs
`

$3

`ts
import { genid } from 'https://esm.sh/bellajs'

console.log(genid())
`

$3

`html

`

APIs

$3

- .isArray(Anything val)
- .isBoolean(Anything val)
- .isDate(Anything val)
- .isElement(Anything val)
- .isEmail(Anything val)
- .isEmpty(Anything val)
- .isFunction(Anything val)
- .isInteger(Anything val)
- .isLetter(Anything val)
- .isNil(Anything val)
- .isNull(Anything val)
- .isNumber(Anything val)
- .isObject(Anything val)
- .isString(Anything val)
- .isUndefined(Anything val)

$3

- .ucfirst(String s)
- .ucwords(String s)
- .escapeHTML(String s)
- .unescapeHTML(String s)
- .slugify(String s)
- .stripTags(String s)
- .stripAccent(String s)
- .truncate(String s, Number limit)
- .replaceAll(String s, String|Array search, String|Array replace)

$3

#### clone(Anything val)

Make a deep copy of a variable.

`js
import { clone } from 'bellajs'

const b = [
1, 5, 0, 'a', -10, '-10', '',
{
a: 1,
b: 'Awesome'
}
]

const cb = clone(b)
console.log(cb)
`

cb now has the same values as b, while the properties are standalone, not reference. So that:

`js
cb[7].a = 2
cb[7].b = 'Noop'

console.log(b[7])
`

What you get is still:

`js
{
a: 1,
b: 'Awesome'
}
`

#### copies(Object source, Object target[[, Boolean requireMatching], Array excepts])

Copy the properties from source to target.

- requireMatching: if true, BellaJS only copies the properties that are already exist in target.
- excepts: array of the properties properties in source that you don't want to copy.

After this action, target will be modified.

`js
import { copies } from 'bellajs'

const a = {
name: 'Toto',
age: 30,
level: 8,
nationality: {
name: 'America'
}
}
const b = {
level: 4,
IQ: 140,
epouse: {
name: 'Alice',
age: 27
},
nationality: {
long: '18123.123123.12312',
lat: '98984771.134231.1234'
}
}

copies(a, b)
console.log(b)
`

Output:

`js
{
level: 8,
IQ: 140,
epouse: {
name: 'Alice',
age: 27
},
nationality: {
long: '18123.123123.12312',
lat: '98984771.134231.1234',
name: 'America'
},
name: 'Toto',
age: 30
}
`

$3

#### pick(Array arr [, Number count = 1])

Randomly choose N elements from array.

`js
import { pick } from 'bellajs'

const arr = [1, 3, 8, 2, 5, 7]
pick(arr, 2) // --> [3, 5]
pick(arr, 2) // --> [8, 1]
pick(arr) // --> [3]
pick(arr) // --> [7]
`


#### sort(Array arr [, Function compare])

Sort the array using a function.

`js
import { sort } from 'bellajs'

const fn = (a, b) => {
return a < b ? 1 : a > b ? -1 : 0
}

sort([3, 1, 5, 2], fn) // => [ 1, 2, 3, 5 ]
`

#### sortBy(Array arr, Number order, String property)

Sort the array by specific property and direction.

`js
import { sortBy } from 'bellajs'

const players = [
{
name: 'Jerome Nash',
age: 24
},
{
name: 'Jackson Valdez',
age: 21
},
{
name: 'Benjamin Cole',
age: 23
},
{
name: 'Manuel Delgado',
age: 33
},
{
name: 'Caleb McKinney',
age: 28
}
]

const result = sortBy(players, -1, 'age')
console.log(result)
`

#### shuffle(Array arr)

Shuffle the positions of elements in an array.

`js
import { shuffle } from 'bellajs'

shuffle([1, 3, 8, 2, 5, 7])
`

#### unique(Array arr)

Remove all duplicate elements from an array.

`js
import { unique } from 'bellajs'

unique([1, 2, 3, 2, 3, 1, 5]) // => [ 1, 2, 3, 5 ]
`

$3

#### curry(fn)

Make a curried function.

`js
import { curry } from 'bellajs'

const sum = curry((a, b, c) => {
return a + b + c
})

sum(3)(2)(1) // => 6
sum(1)(2)(3) // => 6
sum(1, 2)(3) // => 6
sum(1)(2, 3) // => 6
sum(1, 2, 3) // => 6
`

#### compose(f1, f2, ...fN)

Performs right-to-left function composition.

`js
import { compose } from 'bellajs'

const f1 = (name) => {
return f1 ${name}
}
const f2 = (name) => {
return f2 ${name}
}
const f3 = (name) => {
return f3 ${name}
}

const addF = compose(f1, f2, f3)

addF('Hello') // => 'f1 f2 f3 Hello'

const add1 = (num) => {
return num + 1
}

const mult2 = (num) => {
return num * 2
}

const add1AndMult2 = compose(add1, mult2)
add1AndMult2(3) // => 7
// because multiple to 2 first, then add 1 late => 3 * 2 + 1
`


#### pipe(f1, f2, ...fN)

Performs left-to-right function composition.

`js
import { pipe } from 'bellajs'

const f1 = (name) => {
return f1 ${name}
}
const f2 = (name) => {
return f2 ${name}
}
const f3 = (name) => {
return f3 ${name}
}

const addF = pipe(f1, f2, f3)

addF('Hello') // => 'f3 f2 f1 Hello'

const add1 = (num) => {
return num + 1
}

const mult2 = (num) => {
return num * 2
}

const add1AndMult2 = pipe(add1, mult2)
add1AndMult2(3) // => 8
// because add 1 first, then multiple to 2 late => (3 + 1) * 2
`

#### maybe(Anything val)

Return a static variant of Maybe monad.

`js
import { maybe } from 'bellajs'

const plus5 = x => x + 5
const minus2 = x => x - 2
const isNumber = x => Number(x) === x
const toString = x => 'The value is ' + String(x)
const getDefault = () => 'This is default value'

maybe(5)
.map(plus5)
.map(minus2)
.value() // 8

maybe('noop')
.map(plus5)
.map(minus2)
.value() // null

maybe(5)
.if(isNumber)
.map(plus5)
.map(minus2)
.else(getDefault)
.map(toString)
.value() // 'The value is 8'

maybe()
.if(isNumber)
.map(plus5)
.map(minus2)
.map(toString)
.value() // null

maybe()
.if(isNumber)
.map(plus5)
.map(minus2)
.else(getDefault)
.map(toString)
.value() // 'This is default value'
`

$3

#### formatDateString(Date | Timestamp [, String locale [, Object options]])

`js
import {
formatDateString
} from 'bellajs'

const today = new Date()

formatDateString(today) // => Jan 3, 2022, 8:34:28 PM GMT+7

// custom format
formatDateString(today, {
dateStyle: 'short',
timeStyle: 'short',
hour12: true
}) // => 1/3/22, 8:34 PM

// custom locale
formatDateString(today, 'zh') // => 2022年1月3日 GMT+7 下午8:34:28

// custom lang and format
formatDateString(today, 'zh', {
dateStyle: 'short',
timeStyle: 'long',
hour12: true
}) // => 2022/1/3 GMT+7 下午8:34:28

formatDateString(today, 'vi') // => 20:34:28 GMT+7, 3 thg 1, 2022
formatDateString(today, 'vi', {
dateStyle: 'full',
timeStyle: 'full'
}) // => 20:34:28 Giờ Đông Dương Thứ Hai, 3 tháng 1, 2022
`


#### formatTimeAgo(Date | Timestamp [, String locale [, String justnow]])

`js
import {
formatTimeAgo
} from 'bellajs'

const today = new Date()

const yesterday = today.setDate(today.getDate() - 1)
formatTimeAgo(yesterday) // => 1 day ago

const current = new Date()
const aLittleWhile = current.setHours(current.getHours() - 3)
formatTimeAgo(aLittleWhile) // => 3 hours ago

// change locale
formatTimeAgo(aLittleWhile, 'zh') // => 3小时前
formatTimeAgo(aLittleWhile, 'vi') // => 3 giờ trước
`

The last param justnow can be used to display a custom 'just now' message, when the distance is lesser than 1s.

`js
const now = new Date()
const aJiff = now.setTime(now.getTime() - 100)
formatTimeAgo(aJiff) // => 'just now'
formatTimeAgo(aJiff, 'fr', 'à l\'instant') // => à l'instant
formatTimeAgo(aJiff, 'ja', 'すこし前') // => すこし前
`

These two functions based on recent features of built-in object Intl.

Please refer the following resources for more info:

- Intl.DateTimeFormat() constructor
- Intl.RelativeTimeFormat
- Intl.Locale

$3

#### randint([Number min [, Number max]])

Returns a number between min and max

`js
import { randint } from 'bellajs'

randint() // => a random integer
randint(1, 5) // => a random integer between 3 and 5, including 1 and 5
`

#### genid([Number length [, String prefix]])

Create random ID string.

`js
import { genid } from 'bellajs'

genid() // => random 32 chars
genid(16) // => random 16 chars
genid(5) // => random 5 chars
genid(5, 'X_') // => X_{random 3 chars}
`

Test

`bash
git clone https://github.com/ndaidong/bellajs.git
cd bellajs
npm install
npm test
``

License

The MIT License (MIT)