@mphennum/utils v1.1.0

utils

Javascript utilities for strings, numbers, dates, etc.

contents

• install
• usage
• array
• date
• number
• string
• other

install

npm

$ npm install @mphennum/utils

browser

<script src="/path/to/dist/utils.js"></script>

usage

node

import { array } from '@mphennum/utils';
console.log(array.shuffle([ 1, 2, 3, 4, 5 ]));

browser

var array = window.utils.array;
console.log(array.shuffle([ 1, 2, 3, 4, 5 ]));

array

shuffle

Shuffles an array.

var arr = [ 1, 2, 3, 4, 5 ];
array.shuffle(arr); // also returns the shuffled array
console.log({ arr: arr });

date

format

Formats a given date.

var format = date.format(); // returns "0000-00-00T00:00:00.000+00:00" format for current timestamp
var format2 = date.format('1988/01/04', 'Y-m-d H:i:s', true); // returns "1988-01-04 00:00:00", true for utc
var format3 = date.format(0, 'Y-m-d', true); // returns "1970-01-01"
var format4 = date.format(new Date('2019/04/15'), 'M j, Y', true); // returns "April 15, 2019"
console.log({ format: format, format2: format2, format3: format3, format4: format4 });

toTimeAgo

var dt = new Date(Date.now() - 1800000);
var timeAgo = date.toTimeAgo(dt); // returns "30m"
var timeAgo2 = date.toTimeAgo(dt, true); // returns "30 minutes"
console.log({ timeAgo: timeAgo, timeAgo2: timeAgo2 });

number

toCompact

Returns a compact form of a given number.

var compact = number.toCompact(1500); // returns "1.5k"
console.log({ compact: compact });

toOrdinal

Returns a string with corresponding ordinal indicator.

var ordinal = number.toOrdinal(11); // returns "11th"
console.log({ ordinal: ordinal });

string

deaccent

Deaccents a string by replacing unicode characters.

var str = string.deaccent('Fëanor'); // returns "Feanor"
console.log({ str: str });

toSlug

Converts a string into a slug to be used in a url path.

var slug = string.toSlug('Word with spaces'); // returns "word-with-spaces"
console.log({ slug: slug });

other

randId

Generates a random id.

var id = randId(); // generates a random id, usually 5 to 6 chars
var id2 = randId(14); // generates a random id, 14 chars
console.log({ id: id, id2: id2 });

rand

Random helper with multiple options.

var r = rand(); // random float from 0 (inclusive) to 1 (exclusive)
var r2 = rand('string'); // random character from string
var r3 = rand([ 1, 2, 3, 4, 5 ]); // rand item from array
var r4 = rand(1, 4); // rand int from 1 (inclusive) to 4 (inclusive)
console.log({ r: r, r2: r2, r3: r3, r4: r4 });

seqId

Generates a sequential id.

var id = seqId(); // generates a sequential id starting with "a"
var id2 = seqId(3); // generates a sequential id starting with a minimum length of 3 -- "aaa"
var id3 = seqId('ZZZ'); // generates a sequential id starting after "ZZZ" -- "ZZ0"
console.log({ id: id, id2: id2, id3: id3 });