karmia-utility v0.13.1

karmia-utility

Karmia utility suites

Usage

const karmia_utility = require('karmia-utility').default,
    utility = new karmia_utility();

array

array

unique

• list <Array>

Removes duplicate values from an array

count

• list <Array>
• item <*>

Count item in list

range

• start <number>
• stop <number>
• step <number> Default: 1

Get array of integer from start to end

flip

• list <Array>

intersection

• list1 <Array>
• list2 <Array>

Get intersection of two arrays

const list1 = ['a', 'b', 'b', 'c', 'c', 'c'],
    list2 = ['a', 'b'];

console.log(karray.difference(list1, list2));
// => ['a', 'b']

difference

• list1 <Array>
• list2 <Array>

Get difference of two arrays

const list1 = ['a', 'b', 'b', 'c', 'c', 'c'],
    list2 = ['a', 'b'];

console.log(karray.difference(list1, list2));
// => ['c', 'c', 'c']

crypto

hash

hash(algorithm, buffer, encoding)

• algorithm <string>
• buffer <Buffer>
• encoding <string> Input encoding

utility.crypto.hash('md5', Buffer.from('text'), 'binary');

sha1(buffer, encoding)

• buffer <Buffer>
• encoding <string> Input encoding

utility.crypto.sha1(Buffer.from('text'), 'binary');

sha256(buffer, encoding)

• buffer <Buffer>
• encoding <string> Input encoding

utility.crypto.sha256(Buffer.from('text'), 'binary');

sha512(buffer, encoding)

• buffer <Buffer>
• encoding <string> Input encoding

utility.crypto.sha512(Buffer.from('text'), 'binary');

stretching(algorithm, buffer, count, encoding)

• algorithm <string>
• buffer <Buffer>
• count <Number>
• encoding <string> Input encoding

utility.crypto.stretching('sha256', Buffer.from('text'), 10000, 'binary');

hmac

hmac(algorithm, secret, buffer, encoding)

• algorithm <string>
• password <Buffer>
• buffer <Buffer>
• encoding <string> Input encoding

utility.crypto.hmac('md5', 'secret', Buffer.from('text'), 'binary');

hmac_sha1(secret, buffer, encoding)

• password <Buffer>
• buffer <Buffer>
• encoding <string> Input encoding

utility.crypto.hmac_sha1('secret', Buffer.from('text'), 'binary');

hmac_sha256(secret, buffer, encoding)

• password <Buffer>
• buffer <Buffer>
• encoding <string> Input encoding

utility.crypto.hmac_sha256('secret', Buffer.from('text'), 'binary');

hmac_sha512(secret, buffer, encoding)

• password <Buffer>
• buffer <Buffer>
• encoding <string> Input encoding

utility.crypto.hmac_sha512('secret', Buffer.from('text'), 'binary');

encrypt

iv()

const iv = utility.crypto.iv();

encrypt(algorithm, password, buffer, encoding)

• algorithm <string>
• password <Buffer>
• buffer <Buffer>
• encoding <string> Input encoding

const password = Buffer.from('password'),
      data = Buffer.from('text');
utility.crypto.encrypt('aes-256-ctr', password, data, 'binary');

decrypt(algorithm, password, data, encoding)

• algorithm <string>
• password <Buffer>
• data <Object> {data: encrypted}
• encoding <string> Output encoding

const password = Buffer.from('password'),
      data = {data: 'encrypted'};
utility.crypto.decrypt('aes-256-ctr', password, data, 'binary');

encryptiv(algorythm, password, iv, data, encoding)

• algorithm <string>
• password <Buffer>
• iv <Buffer>
• buffer <Buffer>
• encoding <string> Input encoding

const password = Buffer.from('password'),
      iv = Buffer.from('iv'),
      buffer = Buffer.from('text');
utility.crypto.encryptiv('aes-256-gcm', password, iv, data, 'binary');

decryptiv(algorithm, password, iv, data, encoding, tag_encoding)

• algorithm <string>
• password <Buffer>
• iv <Buffer>
• data <Object> {data: encrypted} or {data: encrypted, tag: auth_tag}
• encoding <string> Output encoding
• tag_encoding <string> Auth tag input encoding

const password = Buffer.from('password'),
    iv = Buffer.from('iv'),
    data = {
        data: 'encrypted',
        tag: 'auth_tag'
    };
utility.crypto.decryptiv(algorithm, password, iv, data, 'binary', 'binary');

date

date

getDate()

utility.date.getDate();

getTime()

utility.date.getTime();

getYMD()

utility.date.getYMD();

format(format, date)

// Current time
utility.date.format('Y-m-d H:i:s');

// Specific time
utility.date.format('Y-m-d H:i:s', new Date('1999-08-03 00:00:00'));

random

random

string(length, options)

• length <number>
• options <Object>

// Includes all characters
utility.string.random(16);

// Excludes special characters
utility.string.random(16, {special: false});

// Excludes number
utility.string.random(16, {number: false});

// Exclude upper and special characters
utility.string.random(16, {upper: false, special: false});

// Exclude lower and special characters
utility.string.random(16, {lower: false, special: false});

integer(max, min)

• max <number> Default: Number.MAX_SAFE_INTEGER
• min <number> Default: 0

utility.random.integer(); // 0〜Number.MAX_SAFE_INTEGER

sequence

sequence

constructor

• adapter <object> KarmiaUtilitySequenceAdapter object Default: KarmiaUtilitySequenceAdapterNumber
• initial_value <*> Default: undefined

const sequence = new utility.sequence();

get

const sequence = new utility.sequence();
await utility.get();

string

string

strip

• string <string>
• mask_character <string> Default: " \t\n\r\0\x0B"

// Strip whitespaces
const string = '    Hello, world.    ';
utility.string.strip(string);

// Strip specified characters
const string = '"Hello, world."';
utility.string.strip(string, '"');

lstrip

• string <string>
• mask_character <string> Default: " \t\n\r\0\x0B"

// Strip whitespaces
const string = '    Hello, world.';
utility.string.lstrip(string);

// Strip specified characters
const string = '"Hello, world.';
utility.string.lstrip(string, '"');

rstrip

• string <string>
• mask_character <string> Default: " \t\n\r\0\x0B"

// Strip whitespaces
const string = 'Hello, world.    ';
utility.string.rstrip(string);

// Strip specified characters
const string = 'Hello, world."';
utility.string.rstrip(string, '"');

normalize

• string <string>
• form <string> Default: "NFKC"

const string = '\u202b１２３\r\nＡＢＣ\rｄｅｆ\nｱｲｳｴｵｶﾞ';
utility.string.normalize(string); // Return: '123\nABC\ndef\nアイウエオガ'

unquote

• string <string>

const string = '"Hello, world."';
utility.string.unquote(string);

parse

• string <string>
• delimiter <string/regexp> Default: /,? /
• separator <string/regexp> Default: =

const string = 'key1=value1, key2=value2';
utility.string.parse(string, /,? /, '=');

toBoolean

• string <string>

// Should be true
utility.string.toBoolean('true');
utility.string.toBoolean('True');
utility.string.toBoolean('TRUE');
utility.string.toBoolean('0');
utility.string.toBoolean(1);
utility.string.toBoolean(true);
utility.string.toBoolean('false_1');

// Should be false
utility.string.toBoolean('false');
utility.string.toBoolean('False');
utility.string.toBoolean('FALSE');
utility.string.toBoolean('');
utility.string.toBoolean(0);
utility.string.toBoolean(false);