@jonathandelgado/utility v0.3.1

utility

Common utility library

alert(msg, meta)

Alert logger

assert(condition, onlyIf, msg)

Asserts a condition, throws when the condition is unmet

asyncify(func) => function

Creates an async function that is called next tick

attempt(value, ...args) => *

Attempts to run func within a try block, returning an error or the result

avg(arr) => Number

Averages an array of values

bindClass(scope, traverse)

Binds a class's functions to the parent class

callWith(func, ...args) => function

Creates a wrapper function with arguments pre-set, arguments passed at runtime are appended to the args

capitalize(value) => String

Capitalizes each word of a string

chop(value, len) => Array.<String>

Chops value every len characters

clone(value) => Array | Object

Creates an exact copy of an object without references, this doesn't affect instanced items such as dates

consts

Constants for second, minute, hour, day, week, month and year

contains(value, item) => Boolean

Determines if value contains item

count(value, item) => Number

Counts the occurances of item in value

counter(max) => function

High resolution counter

Returns: function - () => Number

debug(msg, meta)

Debug logger

dedent(str) => String

Removes indentation from strings, so newlines have no starting whitespace

defaultTo(val, def) => *

Returns def if val is undefined, otherwise returns val. If val and def are both objects, will merge val into def

diffArray(a, b) => Object

Determines which elements were added and removed between two arrays - must be shallow non-object keys

Returns: Object - Contains add and rem keys, both are arrays

diffObject(a, b, bail, ns) => Array.<String>

Determines which keys were changed between two objects

endsWith(value, option) => Boolean

Determines if value ends with option

enumerable(value) => Object

Creates an enumerable object

enums

Enumberables for various functions, containing alpha, hex, etc

error(msg, meta)

Error logger

escape(value) => String

Sanitizes value by escaping the string

filter(value, iter) => Array

Filters an array using an iterator

find(value, len, reverse, iter, noClone) => *

Finds and clones matches from an array

Returns: * - If len is not 1, will return an array, otherwise, it will return the first result or undefined

forceLength(value, len, lead) => String

Forces a string length by adding a leading value

forceWithin(value, min, max) => Number

Ensures value is within min and max inclusively

forEach(value, reverse, iter)

Iterates over an array or object

forEachAwait(value, limit, reverse, iter) => *

Iterate over an array or object, but can be used with await

Returns: * - If iter returns a value, the loop is broken and that value is returned here, otherwise, undefined

forNum(len, reverse, iter) => *

Sugared for loop

Returns: * - If iter returns a value, the loop is broken and that value is returned here, otherwise, undefined

forNumAwait(len, limit, reverse, iter) => *

Sugared for loop, but can be used with await

Returns: * - If iter returns a value, the loop is broken and that value is returned here, otherwise, undefined

forUntil(value, reverse, iter) => *

Iterates over an array or object, stopping when something is returned

Returns: * - If iter returns a value, the loop is broken and that value is returned here, otherwise, undefined

forUntilAwait(value, limit, reverse, iter) => *

Iterate over an array or object, stopping when something is returned, but can be used with await

Returns: * - If iter returns a value, the loop is broken and that value is returned here, otherwise, undefined

get(obj, ns) => *

Gets a property from an object using a namespace

getArgs() => Object

Gets the parsed arguments provided to the process

Returns: Object - Arguments without a flag will be in an array in the _ key

getEnv(key) => *

Gets an enviornment variable provided to the process

group(value, iter) => Object

Groups an array based on iterator input

has(obj, ns) => Boolean

Determines if an object has a value at the namespace address

humanize(value) => String

Humanizes a string by capitalizing the first letter and lowercasing the rest

info(msg, meta)

Info logger

isAll(value, iter) => Boolean

Determines if value all pass iter

isAlpha(value) => Boolean

Determines if value only has alphabetical characters

isAlphanumeric(value) => Boolean

Determines if value only has alphanumeric characters

isArray(value) => Boolean

Determines if value is an array

isAscii(value) => Boolean

Determines if value only has ASCII characters

isBoolean(value) => Boolean

Determines if value is a boolean

isBrowser() => Boolean

Determines if environment is a browser

isDate(value) => Boolean

Determines if value is a valid date

isDecimal(value, dec) => Boolean

Determines if value is a number with a dec

isDeepEqual(a, b) => Boolean

Determines if a is deeply equal to b

isDefined(value) => Boolean

Determines if value has been defined

isDivisibleBy(value, option) => Boolean

Determines if value is divisible by option

isEach(value, iter) => Boolean

Determines if value passes each of the iter validations

isEmail(value) => Boolean

Determines if value is an email

isEmpty(value) => Boolean

Determines if a value is empty

isEqual(value, option) => Boolean

Determines if value equals option

isError(value) => Boolean

Determines if value is an error

isEven(value) => Boolean

Determines if value is even

isFloat(value, dec) => Boolean

Determines if value is a float

isFunction(value) => Boolean

Determines if value is a function

isGt(value, option) => Boolean

Determines if value is greater than option

isGtEq(value, option) => Boolean

Determines if value is greater than or equal to option

isHex(value) => Boolean

Determines if value is a hex value

isHexColor(value) => Boolean

Determines if value is a hex color

isInt(value) => Boolean

Determines if value is an integer

isIP(value) => Boolean

Determines if value is an IP, v4 or v6

isIPv4(value) => Boolean

Determines if value is an IP, v4

isIPv6(value) => Boolean

Determines if value is an IP, v6

isLengthWithin(value, min, max) => Boolean

Determines if value has a length within min and max

isLower(value) => Boolean

Determines if value is completely lowercase

isLt(value, option) => Boolean

Determines if value is less than option

isLtEq(value, option) => Boolean

Determines if value is less than or equal to option

isMatch(value, option) => Boolean

Determines if value matches regex

isNil(value) => Boolean

Determines if value is null or undefined

isNull(value) => Boolean

Determines if value is null

isNumber(value) => Boolean

Determines if value is a number

isNumeric(value) => Boolean

Determines if value is strictly numeric

isObject(value) => Boolean

Determines if value is an object

isPlainObject(value) => Boolean

Determines if value is a non-instance object

isProduction() => Boolean

Determines if environment is in production

isPromise(value) => Boolean

Determines if value is a Promise

isRegExp(value) => Boolean

Determines if value is a RegExp

isSlug(value) => Boolean

Determines if value only has slug safe characters

isString(value) => Boolean

Determines if value is a string

isTid(value) => Boolean

Determines if value is a valid tid

isUpper(value) => Boolean

Determines if value is completely uppercase

isUrl(value) => Boolean

Determines if value is a valid URL

isValidJSON(value) => Boolean

Determines if value is valid JSON

isValidRegExp(value) => Boolean

Determines if value is a valid RegExp

isWithin(value, min, max) => Boolean

Determines if value is within min and max

join(value, by=) => String

Joins an array

keys(value) => Array.<String>

Gets an array of keys from an object

limitArgs(func, len) => function

Limits the amount of arguments a function gets

limitCalls(func, len) => function

Limits the amount of times a function can be called

map(value, reverse, iter) => Array | Object

Iterates over an array or object and maps the results

mapAwait(value, limit, reverse, iter) => Array | Object

Iterates over an array or object and maps the results, but can be used with await

max(value) => Number

Reduces an array by getting the max value

merge(dst, src) => Object | Array

Merges two objects together to the dst object, if the dst is not an object, it will consolidate all arguments into a single array

metric(key, val)

Collects metrics for log propogation

min(value) => Number

Reduces an array by getting the min value

namespace(ns, append, toString) => Array | String

Creates a namespace array

noop()

A no-operation function

parseCurrency(value, dec) => Number

Parses value to currency

parsePhone(value) => String

Parses an irregular value to a phone number

percentile(value, percentile) => Number

Gets the percentile of a number array

promisify(func) => function

Turns a callback function into a promise

Returns: function - Will now return a promise instead of using callbacks

promisifyAll(obj) => Object

Iterates over an Object and creates a copy with promisified functions, non-function and functions ending in Sync will be skipped

pushCap(value, max, item) => Number

Pushes to a capped collection

queue(func, limit) => Object

Creates a queue for a function, limits how many instances are running at once

Returns: Object - New queue instance, with an add and isRunning function as well as a pending array

random(min, max) => Number

Generate a random number between and including min and max

randomBlock(len, dict) => String

Generate a random block of characters

range(min, max, inc) => Array.<Number>

Creates a range of numbers between min and max

reduce(value, reverse, iter, initial) => *

Iterates over an array or object to create a single value

reduceAwait(value, reverse, iter, initial) => Promise

Iterates over an array of object to create a single value, but can be used with await

repeat(value, len) => String

Repeats value len amount of times

replace(value, regex, text=) => String

Replaces regex matches of value with text

sample(value, len) => *

Shuffles and returns len items

Returns: * - Will return a single item if len is 1, otherwise an Array

set(obj, ns, value) => *

Sets a property in an object using a namespace

setIntervalAndRun(func, interval)

Creates an interval and runs the function immediately

shuffle(value) => Array

Shuffles an array

size(value, lastIndex) => Number

Gets the length of an array or object

slice(value, idx, len) => Array | String

Slices a string or array at idx

slugify(value) => String

Turns a string into a valid URL slug

sort(value, reverse, by) => Array

Sorts an array by a single or array of keys

split(value, by=) => Array.<String>

Splits a string into an array

spread(value, len, run) => Array

Generates a spread array using value

startsWith(value, option) => Boolean

Determines if value starts with option

sum(value) => Number

Reduce an array by adding the values

template(value, scope) => String

Templates out value using variables declared in the scope object

throttle(func, time, debounce) => function

Throttles or debounces a function

tid(date) => String

Creates a new time id

timeout(promise, time) => Promise

Creates a timeout for a promise

timer() => function

Creates a running timer

Returns: function - () => Number, returns the duration

toArray(value) => Array

Ensures value is an array, slices arguments

toBool(value) => Boolean

Converts value to a boolean

toDate(value, fromUnix) => Date

Converts value to a date

toLower(value) => String

Converts value to lowercase

toNumber(value, dec) => Number

Converts value to a number

toString(value) => String

Converts value to a string

toUnix(value) => Number

Converts value to a UNIX timestamp

toUpper(value) => String

Converts value to uppercase

traverseObj(obj, ns, isSet, value) => *

Traverses an object using a namespace and get/set's the corresponding key

trim(value, regex) => String

Trims value of whitespace or regex

trimInner(value) => String

Trims and consolidates all whitespace in value

trunc(value, len, ellipsis) => String

Truncates value at len

unescape(value) => String

Reverses an escaped string

unique(value, iter) => Array

Ensures all mapped values are unique, eliminating duplicates

values(value) => Array

Returns an array of object values

verbose(msg, meta)

Verbose logger

wait(time) => Promise

A simple timeout using await

waitUntil(func, args) => Promise

Waits until func returns true

warn(msg, meta)

Warn logger

words(value) => Array.<String>

Converts a string into an array of words