@diahkomalasarinpm/laborum-dicta-velit NPM

BellaJS

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

Install & Usage

Node.js

npm i @diahkomalasarinpm/laborum-dicta-velit

# pnpm
pnpm i @diahkomalasarinpm/laborum-dicta-velit

# yarn
yarn add @diahkomalasarinpm/laborum-dicta-velit

Deno

import { genid } from 'https://esm.sh/@diahkomalasarinpm/laborum-dicta-velit'

console.log(genid())

Browser

<script type="module">
import { genid, slugify } from 'https://unpkg.com/@diahkomalasarinpm/laborum-dicta-velit/dist/bella.esm.js'

console.log(genid())
</script>

APIs

DataType detection

.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)

String manipulation

.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)

Data handling

`clone(Anything val)`

Make a deep copy of a variable.

import { clone } from '@diahkomalasarinpm/laborum-dicta-velit'

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:

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

console.log(b[7])

What you get is still:

{
  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.

import { copies } from '@diahkomalasarinpm/laborum-dicta-velit'

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:

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

Array utils

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

Randomly choose N elements from array.

import { pick } from '@diahkomalasarinpm/laborum-dicta-velit'

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.

import { sort } from '@diahkomalasarinpm/laborum-dicta-velit'

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.

import { sortBy } from '@diahkomalasarinpm/laborum-dicta-velit'

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.

import { shuffle } from '@diahkomalasarinpm/laborum-dicta-velit'

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

`unique(Array arr)`

Remove all duplicate elements from an array.

import { unique } from '@diahkomalasarinpm/laborum-dicta-velit'

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

Functional utils

`curry(fn)`

Make a curried function.

import { curry } from '@diahkomalasarinpm/laborum-dicta-velit'

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.

import { compose } from '@diahkomalasarinpm/laborum-dicta-velit'

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.

import { pipe } from '@diahkomalasarinpm/laborum-dicta-velit'

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.

import { maybe } from '@diahkomalasarinpm/laborum-dicta-velit'

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'

Date utils

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

import {
  formatDateString
} from '@diahkomalasarinpm/laborum-dicta-velit'

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]])`

import {
  formatTimeAgo
} from '@diahkomalasarinpm/laborum-dicta-velit'

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.

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:

Random utils

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

Returns a number between min and max

import { randint } from '@diahkomalasarinpm/laborum-dicta-velit'

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.

import { genid } from '@diahkomalasarinpm/laborum-dicta-velit'

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

Test

git clone https://github.com/diahkomalasarinpm/laborum-dicta-velit.git
cd @diahkomalasarinpm/laborum-dicta-velit
npm install
npm test

License

The MIT License (MIT)

uuid type framework watchFile variables formatting tacit pure module eslintconfig properties json-schema descriptors take groupBy callback libphonenumber @@toStringTag concatMap values whatwg utilities ts ReactiveX recursive transpile Uint16Array es2015 ES3 HyBi awesomesauce performance optimist shebang deep description Observables classes dependencies Uint8ClampedArray push babel es2017 setImmediate Object.keys Array.prototype.includes signal sameValueZero immer popmotion ES2019 escape Array.prototype.flatten react pose figlet l10n typanion eventEmitter jest $.extend warning wrap const gradients css3 time superstruct eslintplugin mkdirs ajax tty diff request readable path es2016 argv deepclone validator flag call-bind await dom file system ES2017 banner package lesscss proto ast ava Float64Array express Observable install shrinkwrap negative zero make process uninstall tdd delete call-bound persistent random text tester workspace:*accessor lint extra callbound concat wget pipe WebSockets apollo ECMAScript 2018 https optimizer ES2022 package.json eventDispatcher look exit-code serializer config password types bcrypt dataView zod fast-copy ES2021 mixins last [[Prototype]]ES es-shim API scheme eslint Array.prototype.flat bound merge serialize ECMAScript 3 protocol-buffers sigint trimRight Array gdpr client Uint8Array fetch multi-package RxJS weakset RFC-6455 ES5 value hasOwn toobject guid xterm es7 ArrayBuffer.prototype.slice es8 full regexp entries flatten matches call cjk compiler BigInt64Array pose fast-deep-clone es2018 dir rangeerror ratelimit pretty computed-types duplex promises throat shell bluebird Function.prototype.name sequence functions react-hooks bootstrap less art inspect validate wordbreak modules offset traverse buffer extend length ES8 ES2020 CSS framer cache WebSocket worker yaml polyfill reduce eslint-plugin jsdiff ECMAScript 2016 ie check gestures querystring less.js private data tostringtag code points consume debug language command-line ajv copy fast up parent spinners higher-order RegExp#flags setter Underscore environment findLast limited inference String.prototype.matchAll status curried deterministic move spinner minimal styled-components autoprefixer logger Int16Array Push fastclone fp es-shims bundler drag write less css env serialization folder form trim mime jasmine YAML safe fs Object.is extension RegExp.prototype.flags TypeScript Int8Array ReactiveExtensions has browser URL streams property expression Object.values negative runtime ES2018 jQuery make dir utility east-asian-width bdd typeerror real-time getter iteration Streams logging trimEnd css variable argparse style watch assign chinese regular expression ansi jsdom matchAll deep-clone util.inspect byte hookform 6to5 lazy rmdir side TypeBox unicode array sham readablestream CSSStyleDeclaration ponyfill coercible react-testing-library harmony rate search test Float32Array Promise jsonschema terminal configurable trimStart dotenv patch efficient mobile native Object.getPrototypeOf joi prune Int32Array form-validation react-hook-form __proto__object clone less compiler internal slot 0 positive create error-handling sort open private data ascii waapi reuse find streams2 toolkit ecmascript package manager shim progress datastructure column names dayjs user-streams ender typed array reducer Object.defineProperty once immutable resolve babel-core sharedarraybuffer symbols filter watcher redux less symlinks css-in-js which Object.assign deepcopy read error protobuf mru Map toStringTag rgb getPrototypeOf invariant connect log

1.0.0

16 days ago

@diahkomalasarinpm/laborum-dicta-velit v1.0.0