Skip to main content

Some useful Underscore methods

I like jQuery and I use it in all my projects. Lately I've been looking into Design Patterns and Backbone framework. Backbone has a dependency on Underscore and more often than not, people use Underscore as a client-side templating engine when using Backbone. I was looking at the Underscore documentation and came across a bunch of useful methods.


where:

The where method looks into the array of objects and returns only those objects that contain the specified key value pairs:

var arrayOfObjects = [
{car: 'Ford', model: 'Figo', color: 'red'}, {car: 'Honda', model: 'CRV', color: 'green'}, {car: 'Ford', model: 'EcoSport', color: 'red'} ]; _.where(arrayOfObjects, {color: 'red'});

The above would return the first and the third object in the array.

pluck:

The pluck method allows you to pluck the values for the specified key. Consider the above array and when you run

_.pluck(arrayOfObjects, 'model')

this would return ['Figo', 'CRV', 'EcoSport'] i.e. all the values for the specified key.

countBy:

Consider the same array again, say you want to find the number of objects with the specified key. For example, there are two 'Ford' cars and one 'Honda'. The countBy method returns you this data.

_.countBy(arrayOfObjects, function(currentObject) { return currentObject.car; });

This returns an object {Ford: 2, Honda: 1}

sortBy:

To sort an array of objects with the specified key sortBy function comes in very handy:

_.sortBy(arrayOfObjects, function(currentObject) { return currentObject.model; });

This would rearrange the array of objects alphabetically by car model.

groupBy:

The groupBy function is another great utility if you want to group the objects in an array by some key:

_.groupBy(arrayOfObjects, function(currentObject) { return currentObject.car });

This would retunrn a single object
{
Ford: [
{car: 'Ford', model: 'Figo', color: 'red'},
{car: 'Ford', model: 'EcoSport', color: 'red'}
],
Honda: [
{car: 'Honda', model: 'CRV', color: 'green'}
]
}

shuffle

This utility function would just shuffle the values in the list and every time you run this method it would return you a different shuffled list

_.shuffle([1,2,3,4,5,6,7,8]); [3, 4, 8, 7, 6, 1, 2, 5]

memoize

Memoize allows you to cache the result of a function call. Say there is a function that returns the factorial of a number. If the function is called multiple times with the same value then memoize will return the cached result instead of calling the function.
var factorial = _.memoize( function(n) {     if (n == 1) return 1;     return n * factorial(n-1); }

Now on calling factorial(150) multiple times, the function is invoked only once and fetched from the cached in subsequent calls. When you look at the function definition it makes it clear that the data is returned from the cache and not by computing the result:
function (func, hasher) {     var memo = {};     hasher || (hasher = _.identity);     return function() {       var key = hasher.apply(this, arguments);       return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));     }; }

pairs

The pairs function allows you to convert an object into a array of key-value pairs:

_.pairs({'car': 'Ford', 'model': 'Figo', 'color': 'red'});

This returns a two dimensional array: [['car','Ford'], ['model','Figo'], ['color','red']]

Although there are many other useful methods available in the Underscore library, I've listed the ones I'll be using soon in my everyday projects.

Comments

Popular posts from this blog

Server sent events with HTML5 and ColdFusion

There are several ways to interact with the server apart from the traditional request\response and refresh all protocol. They are polling, long polling, Ajax and Websockets ( pusherapp ). Of all these Ajax and Websockets have been very popular. There is another way to interact with the server such that the server can send notifications to the client using Server Sent Events (SSE) . SSE is a part of HTML5 spec:  http://dev.w3.org/html5/eventsource/

File upload and Progress events with HTML5 XmlHttpRequest Level 2

The XmlHttpRequest Level 2 specification adds several enhancements to the XmlHttpRequest object. Last week I had blogged about cross-origin-requests and how it is different from Flash\Silverlight's approach .  With Level 2 specification one can upload the file to the server by passing the file object to the send method. In this post I'll try to explore uploading file using XmlHttpRequest 2 in conjunction with the progress events. I'll also provide a description on the new HTML5 tag -  progress which can be updated while the file is being uploaded to the server. And of course, some ColdFusion code that will show how the file is accepted and stored on the server directory.

Adding beforeRender and afterRender functions to a Backbone View

I was working on a Backbone application that updated the DOM when a response was received from the server. In a Backbone View, the initialize method would perform some operations and then call the render method to update the view. This worked fine, however there was scenario where in I wanted to perform some tasks before and after rendering the view. This can be considered as firing an event before and after the function had completed its execution. I found a very simple way to do this with Underscore's wrap method.