es5-ext - ECMAScript5 extensions

Methods, functions and objects that are not part of the standard, written with EcmaScript conventions in mind.

Installation

Can be used in any environment that implements EcmaScript 5th edition.
Many extensions will also work with ECMAScript 3rd edition, if they're not let es5-shim be your aid.

To use it with node.js:

$ npm install es5-ext

For browser, you can create custom toolset with help of modules-webmake

Usage

es5-ext mostly offer methods (not functions) which can directly be assigned to native object's prototype:

Function.prototype.curry = require('es5-ext/lib/Function/prototype/curry');

Array.prototype.flatten = require('es5-ext/lib/Array/prototype/flatten');

String.prototype.startsWith = require('es5-ext/lib/String/prototype/starts-with');

However, extending native prototypes is controversial and in general discouraged, most will agree that it's ok only if we own the context (see extending-javascript-natives for more views on that matter).
So when you don't want to extend native prototypes you can use methods as functions:

var util = {};
var call = Function.prototype.call;

util.curry = call.bind(require('es5-ext/lib/Function/prototype/curry'));

util.flatten = call.bind(require('es5-ext/lib/Array/prototype/flatten'));

util.startsWith = call.bind(require('es5-ext/lib/String/prototype/starts-with'));

As with native ones most methods are generic and can be run on any object. In more detail:

Array.prototype, Number.prototype and String.prototype, methods can be run on any object (any value that's neither null nor undefined),
Date.prototype methods should be called only on Date instances.
Function.prototype methods can be called on any callable objects (not necessarily functions)

API doesn't provide any methods for Object.prototype as extending such in any case should be avoided. All Object utils are provided as fuctions and most of them expect first input argument to be a valid object (any value that's neither null nor undefined).

API

Global extensions

global

Object that represents global scope

reserved

List of EcmaScript 5th edition reserved keywords.
Additionally under keywords, future and futureStrict properties we have lists grouped thematically.

Array Constructor extensions

generate([length[, …fill]])

Generate an array of pregiven length built of repeated arguments.

from(x)

In EcmaScript 6th Edition draft
Convert array-like object to an Array

of([…items])

In EcmaScript 6th Edition draft
Create an array from given arguments.

Array Prototype extensions

binarySearch(compareFn)

In sorted list search for index of item for which compareFn returns value closest to 0.
It's variant of binary search algorithm

clear()

Clears the array

commonLeft([…lists])

Returns first index at which lists start to differ

compact()

Returns a copy of the list with all falsy values removed.

contains(searchElement[, position])

Whether list contains the given value.

copy()

Returns a copy of the list

diff(other)

Returns the array of elements that are present in context list but not present in other list.

eIndexOf(searchElement[, fromIndex])

egal version of indexOf method

eLastIndexOf(searchElement[, fromIndex])

egal version of lastIndexOf method

exclusion([…lists]])

Returns the array of elements that are found only in context list or lists given in arguments.

find(query[, thisArg])

Return first element for which given function returns true

first()

Returns value for first declared index

firstIndex()

Returns first declared index of the array

flatten()

Returns flattened version of the array

forEachRight(cb[, thisArg])

forEach starting from last element

group(cb[, thisArg])

Group list elements by value returned by cb function

indexesOf(searchElement[, fromIndex])

Returns array of all indexes of given value

intersection([…lists])

Computes the array of values that are the intersection of all lists (context list and lists given in arguments)

last()

Returns value for last declared index

lastIndex()

Returns last declared index of the array

remove(value)

Remove value from the array

someRight(cb[, thisArg])

some starting from last element

uniq()

Returns duplicate-free version of the array

Boolean Constructor extensions

isBoolean(x)

Whether value is boolean

Date Constructor extensions

isDate(x)

Whether value is date instance

validDate(x)

If given object is not date throw TypeError in other case return it.

Date Prototype extensions

copy(date)

Returns a copy of the date object

daysInMonth()

Returns number of days of date's month

floorDay()

Sets the date time to 00:00:00.000

floorMonth()

Sets date day to 1 and date time to 00:00:00.000

floorYear()

Sets date month to 0, day to 1 and date time to 00:00:00.000

format(pattern)

Formats date up to given string. Supported patterns:

%Y - Year with century, 1999, 2003
%y - Year without century, 99, 03
%m - Month, 01..12
%d - Day of the month 01..31
%H - Hour (24-hour clock), 00..23
%M - Minute, 00..59
%S - Second, 00..59
%L - Milliseconds, 000..999

Error Constructor extensions

isError(x)

Whether value is error.
It returns true for all Error instances and Exception host instances (e.g. DOMException)

validError(x)

If given object is not error throw TypeError in other case return it.

Error Prototype extensions

throw()

Throws error

Function Constructor extensions

Some of the functions were inspired by Functional JavaScript project by Olivier Steele

arguments([…args])

Returns arguments object

arguments.call(…args) =def …args

context()

Returns context in which function was called

context.call(x) =def x

i(x)

Identity function. Returns first argument

i(x) =def x

insert(name, value)

Returns a function that will set name to value on given object

insert(name, value)(obj) =def object[name] = value

invoke(name[, …args])

Returns a function that takes an object as an argument, and applies object's name method to arguments.
name can be name of the method or method itself.

invoke(name, …args)(object, …args2) =def object[name](…args, …args2)

isArguments(x)

Whether value is arguments object

isFunction(arg)

Wether value is instance of function

k(x)

Returns a constant function that returns pregiven argument

k(x)(y) =def x

noop()

No operation function

pluck(name)

Returns a function that takes an object, and returns the value of its name property

pluck(name)(obj) =def obj[name]

remove(name)

Returns a function that takes an object, and deletes object's name property

remove(name)(obj) =def delete obj[name]

Function Prototype extensions

Some of the methods were inspired by Functional JavaScript project by Olivier Steele

chain([…fns])

Applies the functions in argument-list order.

f1.chain(f2, f3, f4)(…args) =def f4(f3(f2(f1(…arg))))

curry([n])

Invoking the function returned by this function only n arguments are passed to the underlying function. If the underlying function is not saturated, the result is a function that passes all its arguments to the underlying function.
If n is not provided then it defaults to context function length

f.curry(4)(arg1, arg2)(arg3)(arg4) =def f(arg1, args2, arg3, arg4)

flip()

Returns a function that swaps its first two arguments before passing them to the underlying function.

f.flip()(a, b, c) =def f(b, a, c)

lock([…args])

Returns a function that applies the underlying function to args, and ignores its own arguments.

f.lock(…args)(…args2) =def f(…args)

Named after it's counterpart in Google Closure

match()

Returns a function that applies underlying function with first list argument

f.match()(args) =def f.apply(null, args)

memoize([, length[, resolvers]])

Memoizes function results, works with any type of input arguments.

memoizedFn = memoize.call(fn);

memoizedFn('foo', 3);
memoizedFn('foo', 3); // Result taken from cache

Arguments length

By default fixed number of arguments that function takes is assumed (it's read from fn.length property) this behaviour can be overriden by providing custom length setting e.g.:

memoizedFn = memoize(fn, 2);

or we may pass false as length:

memoizeFn = memoize(fn, false);

which means that number of arguments is dynamic, and memoize will work with any number of them.

Resolvers

If we expect arguments of certain types it's good to coerce them before doing memoization. We can do that by passing additional resolvers array. Each item is function that would be run on given argument, value returned by function is accepted as coerced value.

memoizeFn = memoize(fn, 2, [String, Boolean]);

Cache handling

Collected cache can be cleared. To clear all collected data:

memoizedFn.clearAllCache();

or data for particall call:

memoizedFn.clearCache('foo', true);

not()

Returns a function that returns boolean negation of value returned by underlying function.

f.not()(…args) =def !f(…args)

partial([…args])

Returns a function that when called will behave like context function called with initially passed arguments. If more arguments are suplilied, they are appended to initial args.

f.partial(…args1)(…args2) =def f(…args1, …args2)

silent()

Returns a function that when called silents any error thrown by underlying function. If underlying function throws error, it is the result fo the function.

function () { throw err; }.silent()() ==def err

wrap(fn)

Wrap function with other function, it allows to specify before and after behavior, transform return value or prevent original function from being called.

Inspired by Prototype's wrap

Number Constructor extensions

isNaN(x)

In EcmaScript 6th Edition draft

Whether value is NaN. Differs from global isNaN that it doesn't do type coercion. See http://wiki.ecmascript.org/doku.php?id=harmony:number.isnan

isNumber(x)

Whether given value is number

toInt(x)

In EcmaScript 6th Edition draft

Converts value to integer

toUint(x)

Converts value to unsigned integer

toUint32(x)

Converts value to unsigned 32 bit integer. This type is used for array lengths. See: http://www.2ality.com/2012/02/js-integers.html

Number Prototype extensions

pad(length[, precision])

Pad given number with zeros. Returns string

Object Constructor extensions

bindMethods(obj[, context[, source]])

Bind all object functions to given scope. If scope is not given then functions are bound to object they're assigned to. This emulates Python's bound instance methods. If source (second argument) is present then all functions from source are binded to scope and assigned to object.

Inspired by: http://mochi.github.com/mochikit/doc/html/MochiKit/Base.html#fn-bindmethods

clear(obj)

Remove all enumerable own properties of the object

clone(obj)

Returns clone that shares all properties of the object and have same prototype as the object

compact(obj)

Returns copy of the object with all enumerable properties that have no falsy values

compare(obj1, obj2)

Universal cross-type compare function. To be used for e.g. array sort.

copy(obj[, deep])

Returns copy of the object with all enumerable properties. Additionally nested objects can be copied as well

count(obj)

Counts number of enumerable own properties on object

descriptor([mode[, value]])

descriptor.gs([mode[, get[, set]]])

Descriptor factory. mode is string, through we which we define whether value should be configurable, enumerable and/or writable, it's accepted as string of tokens, e.g.: c, ce, cew, cw, e, ew, w If mode is not provided than cw mode is assumed (it's how standard methods are defined on native objects).
To setup descriptor with getter and/or setter use descriptor.gs, mode is configured same way as in value version, only difference is that settings for writable attribute are ignored.

diff(obj1, obj2)

Returns differences between two objects (taking into account only its own enumerable properties). Returned object is array of three arrays. Each array holds property names:

0 - properties that were not present in obj2
1 - properties that have different values
2 - properties that were not present in obj1

every(obj, cb[, thisArg[, compareFn]])

Analogous to Array.prototype.every. Returns true if every key-value pair in this object satisfies the provided testing function.
Optionally compareFn can be provided which assures that keys are tested in given order. If provided compareFn is equal to true, then order is alphabetical (by key).

extend(dest[, …src])

Extend dest by enumerable own properties of other objects. Properties found in both objects will be overwritten.

extendProperties(dest[, …src])

Extend dest by all own properties of other objects. Properties found in both objects will be overwritten (unless they're not configrable and cannot be overwritten).

filter(obj, cb[, thisArg])

Analogous to Array.prototype.filter. Returns new object with properites for which cb function returned truthy value.

flatten(obj)

Returns new object, with flatten properties of input object

flatten({ a: { b: 1 }, c: { d: 1 } }) =def { b: 1, d: 1 }

forEach(obj, cb[, thisArg[, compareFn]])

Analogous to Array.prototype.forEach. Calls a function for each key-value pair found in object Optionally compareFn can be provided which assures that properties are iterated in given order. If provided compareFn is equal to true, then order is alphabetical (by key).

getPropertyNames()

Get all (not just own) property names of the object

is(x, y)

In EcmaScript 6th Edition draft as is operator

Whether two values are equal, takes into account NaN and -0/+0 cases

isCallable(x)

Whether object is callable

isCopy(obj1, obj2)

Compares two objects.
Object is considered a copy when its own enumerable properties match own enumerable properties of other object

isEmpty(obj)

True if object doesn't have any own enumerable property

isList(x)

Whether object is array-like object

isObject(arg)

Whether value is not primitive

isPlainObject(arg)

Whether object is plain object, its protototype should be Object.prototype and it cannot be host object.

keyOf(obj, searchValue)

Search object for value

map(obj, cb[, thisArg])

Analogous to Array.prototype.map. Creates a new object with properties which values are results of calling a provided function on every key-value pair in this object.

mapKeys(obj, cb[, thisArg])

Create new object with same values, but remapped keys

mapToArray(obj[, cb[, thisArg[, compareFn]]])

Creates an array of results of calling a provided function on every key-value pair in this object.
Optionally compareFn can be provided which assures that results are added in given order. If provided compareFn is equal to true, then order is alphabetical (by key).

some(obj, cb[, thisArg[, compareFn]])

Analogous to Array.prototype.some Returns true if any key-value pair satisfies the provided testing function.
Optionally compareFn can be provided which assures that keys are tested in given order. If provided compareFn is equal to true, then order is alphabetical (by key).

validCallable(x)

If given object is not callable throw TypeError in other case return it.

validValue(x)

Throws error if given value is null or undefined, otherwise returns true.

values(obj)

Return array of object own enumerable properties

RegExp Constructor extensions

isRegExp(x)

Whether object is regular expression

String Constructor extensions

guid()

Returns globally unique string identifier, it starts with a digit and is followed by any characters from 0-9 and a-z range. Length of string is 9 characters but may increase in future.
Simple and friendly implementation for common web application purpose (it's format is different from official GUID format)

isString(x)

Whether object is string

String Prototype extensions

caseInsensitiveCompare(str)

Case insensitive compare

contains(searchString[, position])

In EcmaScript 6th Edition draft
Whether string contains given string.

dashToCamelCase()

Convert dash separated string to camelCase, e.g. one-two-three -> oneTwoThree

endsWith(searchString[, endPosition])

In EcmaScript 6th Edition draft
Whether strings ends with given string

format(fmap[, thisArg])

Formats given template up to provided map, e.g.:

"%capital is a capital of %country".format({
	capital: "Warsaw",
	country: "Poland"
}); // -> "Warsaw is a capital of Poland"

Map may also provide not direct values but functions that resolve value, in that case optional thisArg determines the context in which functions are called.

indent(str[, count])

Indents each line with provided str (if count given then str is repeated count times).

last()

Return last character

pad(fill[, length])

Pad string with fill. If length si given than fill is reapated length times. If length is negative then pad is applied from right.

repeat()

Repeat given string n times

startsWith(searchString[, position])

In EcmaScript 6th Edition draft
Whether strings starts with given string

trimCommonLeft([…strings])

Returns string left trimmed by characters same for all strings

Math Object extensions

sign(n)

In EcmaScript 6th Edition draft
Returns sign of a number value

Tests

$ npm test

README.md 18 KB History Raw

es5-ext - ECMAScript5 extensions

Installation

Usage

API

Global extensions

global

reserved

Array Constructor extensions

generate([length[, …fill]])

from(x)

of([…items])

Array Prototype extensions

binarySearch(compareFn)

clear()

commonLeft([…lists])

compact()

contains(searchElement[, position])

copy()

diff(other)

eIndexOf(searchElement[, fromIndex])

eLastIndexOf(searchElement[, fromIndex])

exclusion([…lists]])

find(query[, thisArg])

first()

firstIndex()

flatten()

forEachRight(cb[, thisArg])

group(cb[, thisArg])

indexesOf(searchElement[, fromIndex])

intersection([…lists])

last()

lastIndex()

remove(value)

someRight(cb[, thisArg])

uniq()

Boolean Constructor extensions

isBoolean(x)

Date Constructor extensions

isDate(x)

validDate(x)

Date Prototype extensions

copy(date)

daysInMonth()

floorDay()

floorMonth()

floorYear()

format(pattern)

Error Constructor extensions

isError(x)

validError(x)

Error Prototype extensions

throw()

Function Constructor extensions

arguments([…args])

context()

i(x)

insert(name, value)

invoke(name[, …args])

isArguments(x)

isFunction(arg)

k(x)

noop()

pluck(name)

remove(name)

Function Prototype extensions

chain([…fns])

curry([n])

flip()

lock([…args])

match()

memoize([, length[, resolvers]])

Arguments length

Resolvers

Cache handling

not()

partial([…args])

silent()

wrap(fn)

Number Constructor extensions

README.md 18 KB

History Raw