Javascript prototype extensions

The power of lodash, async, component-type, PLUS a few other useful helpers conveniently placed on the prototypes of the built in Javascript Objects.

To avoid collisions with other prototype augmentations you may have, extensions prefixes everything with $.

//example of async series (https://github.com/caolan/async#seriestasks-callback)
[
    function(cb){ console.log('one'); cb(); },
    function(cb){ console.log('two'); cb(); },
    function(cb){ console.log('three'); cb(); }
]
.$series(function(){
    console.log('done!');
});

Do not open an issue saying that augmenting prototypes is bad. I'm a big boy that can ride my bike without training wheels now and I'm going to go have fun.

If something you read 10 years ago has still got you are scared of augmenting the prototype of the String,Object,Number, and Date objects then do not use this module.

Everything uses Object.defineProperty (introduced in ECMAScript 5) with enumerable:false.

This is NOT a crazy big lib. Seriously- open extensions.js and see for yourself.

npm install extensions

FYI...

This module does not exporting anything. It just needs to be require'd somewhere.

//app.js

require("extensions")

async & lodash

As many of the async & lodash functions have been available as possible. For access to the entire frameworks, you can use $async and $_ respectively.

For a full list, check out the source:
https://github.com/williamkapke/extensions/blob/master/extensions.js#L123

#Object Extensions

Object.prototype.$property(name, options, value)

Helper for Object.defineProperty to set a property value with configuration options.

var x = {}.$property("foo", "ecw", 123);
console.log(x.foo);

options

A string of flags indicating which options you want enabled. Any options not found in the string are false. w = writable e = enumerable c = configurable

value

The value you want the property set to.

Object.prototype.$getter(name, options, getter)

Helper for Object.defineProperty to create a getter with configuration options.

var x = {}.$getter("foo", "ec", function(){ return 123; });
console.log(x.foo);

options

A string of flags indicating which options you want enabled. Any options not found in the string are false. e = enumerable c = configurable

getter

The getter function for the property.

$flatten([delimiter='.'])

Creates a flattened object by using dot notation (by default) properties on nested objects.

Specify the delimiter to use something other than a '.'

console.log({foo:{bar:{baz:123}}}.$flatten());
// { 'foo.bar.baz': 123 }

Object.prototype.$get(path)

Gets a nested value from an object using dot notation.

console.log({foo:{bar:{baz:123}}}.$get('foo.bar.baz'));
// 123

Object.prototype.$set(path, value)

Sets a nested value of an object using dot notation.

console.log(
  {}
  .$set('foo.bar.baz', 123)
  .$set('foo.bar.zip', 999)
  .$set('foo.bam.zip', 523)
);
// { foo: { bar: { baz: 123, zip: 999 }, bam: { zip: 523 } } }

Object.$type(obj)

Object.prototype.$type(obj)

See type-of

Object.prototype.$json

Shortcut for JSON.stringify(obj)

Object.prototype.$json2

Shortcut for JSON.stringify(obj, null, 2)

Object.prototype.$signature

Although this is on Object.prototype, it explicitly only works on an arguments Object.

var fn = function(){ console.log(arguments.$signature) };

var fn = function(){ return arguments.$signature };

console.log( fn(1, true, function(){}) );
//number,boolean,function

console.log( fn("hello") );
//string

console.log( fn(/jazz/, new Date) );
//regexp,date

Use it like this:

function connect(){
    switch(arguments.$signature){
        case "number,boolean,function":
            return foo.apply(this, arguments);
        case "string":
            return bar.apply(this, arguments);
        case "regexp,date":
            return baz.apply(this, arguments);
    }
}

String Extensions

String.prototype.$padStart(length [,padchar])

String.prototype.$padEnd(length [,padchar])

Adds characters to the beginning or end of the String. length is the total length you want the resulting string to be.

If you want to add n number of characters to a string, do this:

//add 3 zeros to the beginning
var x = "EasyPeezy";
console.log(x.$padStart(x.length+3, '0'));
//000EasyPeezy

String.prototype.$endsWith(string)

String.prototype.$startsWith(string)

It does what you think it does.

String.prototype.$isLongerThan(length)

String.prototype.$isShorterThan(length)

String.prototype.$lengthIsBetween(min,max)

Test the length of the String.

String.$isEmail(str)

String.prototype.$isEmail()

Tests if it matches a big long email RegExp.

String.prototype.$remove(string|regex)

This is an alias for:

var x = "The Quick Brown".replace(value, '');

String.prototype.$in(array|args)

Test if the String is in the array/arguments.

var x = "99".in([1,5,33,77,99,32425]);
//true
var x = "dog".in("cat", "pig", "horse", "dog", "cow");
//true

String.prototype.$mask()

Converts a comma separated list of property names to a field mask. (Useful for mongo)

console.log("foo,bar,baz".$mask())
// { foo: 1, bar: 1, baz: 1 }

#Array Extensions

Array.prototype.$mask()

Converts an Array of property names to a field mask. (Useful for mongo)

console.log(["foo","bar","baz"].$mask())
// { foo: 1, bar: 1, baz: 1 }

Date Extensions

Date.$midnight([date])

Returns a new Date object that is set to midnight of date. date defaults to new Date() if not passed in.

Date.prototype.$midnight()

Returns a new Date object that is set to midnight.

Date.$midnightUTC([date])

Date.prototype.$midnightUTC()

The usual UTC equivelants.

Date.$nowISO()

A shortcut for (new Date()).toISOString()

Date.prototype.$addDays(num)

Adds num days to the date.

Number Extensions

Number.prototype.$isBetween(min,max)

min and max are inclusive. Just like if you say "Pick a number between 1 and 100."

(un)license

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to [http://unlicense.org]