node-extensions v1.12.3

Node Extensions

Extend Node's global object. No dependencies except semver.

Usage

npm install --save node-extensions

This package attachs APIs to global object (like es5-shim), so what you need to do is just require it once in your project's main file, e.g. index.js or app.js. That's all.

Recommend to require node extensions on the very top of file.

require('node-extensions')

var obj = { 0: 'Hello', 1: 'Node', length: 2 }

console.log(Array.from(obj).reduce(function (prev, cur) {
  return prev + ' ' + cur
}))
// 'Hello Node'

var fruits = ['Apple', 'Orange']

if (fruits.isEmpty === false) {
  // do somethinge
}

'the great gatsby'.toCapitalCase() // 'the Great Gatsby'

Browser

Please use module bundler like Browserify or Webpack:

require('node-extensions/browser')

APIs

Object

Methods

assign

http://people.mozilla.org/~jorendorff/es6-draft.html#sec-object.assign

Object.assign(
    { type: 'node' },
    { name: 'node-extensions' }
)
// { type: 'node', name: 'node-extensions' }

hasProps

let obj = {
  foo: {
    bar: {
      baz: 'baz'
    }
  }
}

Object.hasProps(obj, 'foo.bar.baz') // true
Object.hasProps(obj, 'foo.bar.foobar') // false

isObject

Object.isObject({}) === true
Object.isObject(new Date) === false
Object.isObject(/reg/) === false
Object.isObject(undefined) === false
Object.isObject(null) === false

isNull

Object.isNull(null) === true
Object.isNull(undefined) === false

isUndefined

Object.isUndefined(undefined) === true
Object.isUndefined(null) === false

merge

Deep version of Object#assign().

Object.merge(
    { project: { type: 'node' } },
    { project: { name: 'node-extensions' } }
)
// { project: { type: 'node', name: 'node-extensions' } }

pick

Creates a new object that only contain specific keys.

let obj = {
  foo: 'foo',
  bar: 'bar',
  baz: 'baz'
}

Object.pick(obj, 'foo', 'bar')
Object.pick(obj, ['foo', 'bar'])
// { foo: 'foo', bar: 'bar' }

Object.pick(obj, (value, key) => key.startsWith('ba'))
Object.pick(obj, (value, key) => key.startsWith(this.prefix) }, { prefix: 'ba' })
// { bar: 'bar', baz: 'baz' }

props

let obj = {
  foo: {
    bar: {
      baz: 'baz'
    }
  }
}

Object.props(obj, 'foo.bar.baz') // 'baz'
Object.props(obj, 'foo.bar.foobar') // undefined

Array

Properties

first

[1, 2].first === 1
[].first === undefined
[null].first === null

isEmpty

[].isEmpty === true
[1].isEmpty === false
[ , ].isEmpty === true
[null].isEmpty === false

last

[1, 2].last === 2
[].last === undefined
[null].last === null

Methods

compact

compact()

Like Ruby's Array#compact(), creates a new array that all undefined and null elements removed, or a new array with all elements that pass the test implemented by the provided function.

compact(mapfn[, thisArg]) alias of Array#filter().

[1, , null, 2].compact() // [1, 2]

['foo', 'bar', 1, 2].compact(function (item) {
    return typeof item === 'string'
}) // ['foo', 'bar']

collect(callback, thisArg)

[1, undefined, null, 2].collect(item => item) // [1, null, 2]

['foo', 'bar', 1, 2].collect(item => {
  if (String.isString(item)) {
    return item + 'baz'
  }
}) // ['foobaz', 'barbaz']

equalTo

equalTo(target, mapfn, thisArg)

[1, 2].equalTo([1, 2]) === true
['a', 1, true].equalTo(['a', 1, true]) === true

[new Date(2014, 0, 1)].equalTo([new Date(2014, 0, 1)]) === false

[new Date(2014, 0, 1)].equalTo([new Date(2014, 0, 1)], function (a, b) {
    return a.getTime() === b.getTime()
}) === true

includes

[1, 2, 3].includes(2) === true
// Array#contains is an alias of Array#includes
[1, 2, 3].contains(2) === true

insert

Array.insert(element, position)

var arr = [1, 2, 3]
arr.insert(5) // [1, 2, 3, 5]
arr.insert(4, 3) // [1, 2, 3, 4, 5]

find & findIndex

[1, 2, 3].find(function (item) {
    return item % 2 === 0
}) // 2

[1, 2, 3].findIndex(function (item) {
    return item % 2 === 0
}) // 1

flatten

[1, [2, [3, [4, { 0: 5, length: 1 }]]]].flatten() // [1, 2, 3, 4, 5]

from

http://people.mozilla.org/~jorendorff/es6-draft.html#sec-array.from

For now, only support array and array-like object.

Array.from({ 0: 'a', 1: 'b', length: 2 })
// [ 'a', 'b' ]

Array.from('abc')
// [ 'a', 'b', 'c' ]

Array.from(new String('abc'))
// [ 'a', 'b', 'c' ]

isArrayLike

Array.isArrayLike({ 0: 'a', 1: 'b', length: 2 }) === true
Array.isArrayLike('abc') === true
Array.isArrayLike(new String('abc')) === true

Array.isArrayLike({ 0: 'a', 1: 'b' }) === false
Array.isArrayLike(1) === false
Array.isArrayLike(true) === false

var b = new Boolean(true)
b.length = 4
Array.isArrayLike(b) === false

isEmpty

Array.isEmpty([]) === true
Array.isEmpty([ , ]) === true

Iterators

forEach, map, every, some, filter, reduce, reduceRight, indexOf, lastIndexOf and 'slice' are overrided for performance concerned.

The new methods are faster than built-in methods. By overriding the built-in methods, the general performances of using built-in methods should be improved. More details: benchmarks.

array.forEach(iterator).map(iterator)

[1, 2, 3].forEachRight(function (item) {
    console.log(item)
})
// 3, 2, 1

of

http://people.mozilla.org/~jorendorff/es6-draft.html#sec-array.of

Array.of(1);         // [1]
Array.of(1, 2, 3);   // [1, 2, 3]
Array.of(undefined); // [undefined]

pluck

Creates a collection for property values of path in all elements

var members = [{ name: 'John', gender: 'male' }, { name: 'Jane', gender: 'female' }]
members.pluck('name')
// ['John', 'Jane']

remove

Array.remove(element, startPosition)

var arr = ['foo', 'bar', 'foo']
arr.remove('foo', 1) // 'foo'
arr // ['foo', 'bar']
arr.remove('foo', 1) // undefined
arr // ['foo', 'bar']

Boolean

Methods

isBoolean

isBoolean(target)

Boolean.isBoolean(true) // true
Boolean.isBoolean(false) // true
Boolean.isBoolean(new Boolean(true)) // true
Boolean.isBoolean('true') // false

String

Properties

isEmpty

''.isEmpty === true
'  '.isEmpty === true
'str'.isEmpty === false

Methods

caseCmp

Like Ruby's casecmp.

'foo'.caseCmp('FOo') // true
'foo'.caseCmp(new String('foo')) // false
'foo'.caseCmp('FOo', true) // false

endsWith

http://people.mozilla.org/~jorendorff/es6-draft.html#sec-string.prototype.startswith

'Hello'.endsWith('o') === true
'Hello'.endsWith('O') === false
'Hello'.endsWith('l') === false
'Hello'.endsWith('l', 4) === true

includes

http://people.mozilla.org//~jorendorff/es6-draft.html#sec-string.prototype.includes

'str'.includes('t') === true
'str'.includes('sub') === false
'substr'.includes('sub', 1) === false
// String#contains availables as an alias of String#includes
'str'.contains('t') === true

isEmpty

String.isEmpty('') === true
String.isEmpty(' ') === true

isString

String.isString('str') === true
String.isString(new String('str')) === true
String.isString(true) === false

interpolate

'Good morning, ${title} #{lastname}.'.interpolate({
    title: 'Mr.',
    lastname: 'Smith'
})
'Good morning, ${0} #{2}.'.tpl(['Mr.', 'John', 'Smith'])
'Good morning, ${0} #{2}.'.template('Mr.', 'John', 'Smith')
// all outputs 'Good morning, Mr. Smith.'

You can use $ and # for defining parameters.

Aliases: String#tpl() & String#template()

padStart / padEnd

'foo'.padStart(10, 'bar') // barbarbfoo
'foo'.padEnd(10, 'bar') // foobarbarb

repeat

http://people.mozilla.org/~jorendorff/es6-draft.html#sec-string.prototype.repeat

'*'.repeat(5) === '*****'

startsWith

http://people.mozilla.org/~jorendorff/es6-draft.html#sec-string.prototype.startswith

'Hello'.startsWith('H') === true
'Hello'.startsWith('h') === false
'Hello'.startsWith('e') === false
'Hello'.startsWith('e', 1) === true

toCamelCase

http://stackoverflow.com/a/10425344

'hello   world'.toCamelCase() === 'helloWorld'
'hello----world'.toCamelCase() === 'helloWorld'
'hello___world'.toCamelCase() === 'helloWorld'
'hello_world'.toCamelCase() === 'helloWorld'
'hello.world'.toCamelCase() === 'hello.world'
'hello.nodejs   world'.toCamelCase() === 'hello.nodejsWorld'

// Make first letter camel cased
'hello   world'.toCamelCase(true) === 'HelloWorld'
'hello----world'.toCamelCase(true) === 'HelloWorld'
'hello___world'.toCamelCase(true) === 'HelloWorld'
'hello_world'.toCamelCase(true) === 'HelloWorld'
'hello.world'.toCamelCase(true) === 'Hello.world'
'hello.nodejs   world'.toCamelCase(true) === 'Hello.nodejsWorld'

toCapitalCase

'hello world'.toCapitalCase() === 'Hello World'
'hello-world'.toCapitalCase() === 'Hello-world'
'the great gatsby'.toCapitalCase() === 'the Great Gatsby'

Note: I'm not a native speaker of English, use it at your own risk. Any contributions would be appreciated.

Function

Methods

isCallable

http://people.mozilla.org/~jorendorff/es6-draft.html#sec-iscallable

function fn () {}
Function.isCallable(fn) === true

var obj = { call: function () {} }
Function.isCallable(obj) === true

Function.isCallable(Date) === true

isFunction

Function.isFunction(function () {}) === true
Function.isFunction({}) === false

Symbol is not supported.

Number

Methods

isFloat

Number.isFloat(1.1) === true
Number.isFloat(-1.1) === true

Number.isFloat(1) === false
Number.isFloat(-1) === false
Number.isFloat(0) === false
Number.isFloat(1.0) === false
Number.isFloat('') === false
Number.isFloat('0') === false
Number.isFloat(NaN) === false
Number.isFloat(true) === false

isInteger

http://www.ecma-international.org/ecma-262/6.0/#sec-number.isinteger

Number.isInteger(1) === true
Number.isInteger(-1) === true
Number.isInteger(0) === true
Number.isInteger(1.0) === true

Number.isInteger(1.1) === false
Number.isInteger('') === false
Number.isInteger('0') === false
Number.isInteger(NaN) === false
Number.isInteger(true) === false

Notes

Overriding Properties

Due to the limitation of Object.defineProperty, you have to use it when overriding properties:

var s = ''
s.isEmpty = 'hello'
s.isEmpty // true

Object.defineProperty(String.prototype, 'isEmpty', {
    value: 'hello'
})

s.isEmpty // 'hello'