bellajs

BellaJS

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

Contents

• Setup
• APIs
  • DataType detection
  • String manipulation
  • Template
  • Date format
  • Other utils
    • clone
    • copies
    • createId
    • equals
    • md5
    • random
    • unique
    • curry
    • compose
    • pipe
• Test
• License

Setup

• Node.js

  npm install bellajs
  

• CDN

  • bella.js
  • bella.min.js
  • bella.min.map

• Also supports ES6 Module, CommonJS, AMD and UMD style.

Usage

var bella = require('bellajs');

// or:
import bella from 'bellajs';

// or import several methods only
import {
  isArray,
  isString
} from 'bellajs';

// similar:
var {
  isArray,
  isString
} = require('bellajs');

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)
• .isNull(Anything val)
• .isNumber(Anything val)
• .isObject(Anything val)
• .isString(Anything val)
• .isUndefined(Anything val)

String manipulation

• .createAlias(String s)
• .encode(String s)
• .decode(String s)
• .ucfirst(String s)
• .ucwords(String s)
• .escapeHTML(String s)
• .unescapeHTML(String s)
• .stripTags(String s)
• .stripAccent(String s)
• .trim(String s [, Boolean nospace])
• .truncate(String s, Number limit)
• .repeat(String s, Number times)
• .leftPad(String s, Number limit, String pad)
• .rightPad(String s, Number limit, String pad)
• .replaceAll(String s, String|Array search, String|Array replace)

Template

• .template(String tpl)

Returns an object with .compile() method

Example:

var tpl = [
  '<article>',
    '<a href="{link}">{title}</a>',
    '<p>{content}</p>',
    '<p>',
      '<span>{author.name}</span>',
      '<span>{author.email}</span>',
    '</p>',
  '</article>'
].join('');

var data = {
  title: 'Hello world',
  link: 'http://google.com',
  content: 'This is an interesting thing, is that right?',
  author: {
    name: 'Dong Nguyen',
    email: '[e-mail]'
  }
}

var html = bella.template(tpl).compile(data);
console.log(html);

Date format

• .relativize([Date | Timestamp])
• .format([Date | Timestamp] [, String pattern])
• .local([Date | Timestamp])
• .utc([Date | Timestamp])

Default pattern for .format() method is D, M d, Y H:i:s A.

Pattern for .local() and .utc() is D, j M Y h:i:s O.

Here are the available characters:

• Y: full year, ex: 2050
• y: short year, ex: 50
• F: full month name, ex: August
• M: short month name, ex: Aug
• m: month index with zero, ex: 08 (in 08/24/2050)
• n: short month name with no zero, ex: 8 (in 8/24/2050)
• S: the ordering subfix for date, ext: 1st, 2nd, 3rd, 4th
• j: day of the month, with no zero, ex: 3 (in 18/3/2050)
• d: day of the month, with zero, ex: 03 (in 18/03/2050)
• t: date in year
• w: weekday in number
• l: long name of weekday, ex: Sunday
• D: short name of weekday, ex: Sun
• G: hour, with no zero: 0 - 24
• g: hour, with no zero: 0 - 12
• h: hour, with zero: 00 - 24
• i: minute: 00 - 59
• s: second: 00 - 59
• a: am, pm
• A: AM, PM
• O: timezone

Example:

import {
  relativize,
  format,
  local,
  utc
} from 'bellajs';

let t = 1509628030108;

relativize(t); //=> 2 seconds ago
format(t, 'Y/m/d h:i:s'); //=> 2017/11/02 20:07:10
local(t); //=> Thu, 2 Nov 2017 20:07:10 GMT+0007
utc(t); //=> Thu, 2 Nov 2017 13:07:10 GMT+0000

Other utils

.clone(Anything val):

Return a copy of val.

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

let cb = bella.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.

Example:

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

bella.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
}

.createId([Number length [, String prefix]])

import {createId} from 'bellajs';

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

.equals(Anything a, Anything b)

import {equals} from 'bellajs';

equals({}, {}); // => true
equals(0, 1); // => false

.md5(String s)

import {md5} from 'bellajs';

md5('abc'); // => 900150983cd24fb0d6963f7d28e17f72

.random([Number min [, Number max]])

import {random} from 'bellajs';

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

.unique(Array a)

import {unique} from 'bellajs';

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

.curry(fn)

import {curry} from 'bellajs';

let 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 'bellajs';

let f1 = (name) => {
  return `f1 ${name}`;
};
let f2 = (name) => {
  return `f2 ${name}`;
};
let f3 = (name) => {
  return `f3 ${name}`;
};

let addF = compose(f1, f2, f3);

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

let add1 = (num) => {
  return num + 1;
};

let mult2 = (num) => {
  return num * 2;
};

let 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 'bellajs';

let f1 = (name) => {
  return `f1 ${name}`;
};
let f2 = (name) => {
  return `f2 ${name}`;
};
let f3 = (name) => {
  return `f3 ${name}`;
};

let addF = pipe(f1, f2, f3);

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

let add1 = (num) => {
  return num + 1;
};

let mult2 = (num) => {
  return num * 2;
};

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

Note

Some parts of bella have been split to separate modules, including:

• bella.stabilize: stabilize.js
• bella.scheduler: bella-scheduler
• bella.detector: device-detector

Test

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

License

The MIT License (MIT)