Backbone plugin to make model actions doable
JavaScript CSS
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

 ____                     __      __                                  ____
/\  _`\                  /\ \    /\ \                                /\  _`\
\ \ \L\ \     __      ___\ \ \/'\\ \ \____    ___     ___      __    \ \ \/\ \    ___
 \ \  _ <'  /'__`\   /'___\ \ , < \ \ '__`\  / __`\ /' _ `\  /'__`\   \ \ \ \ \  / __`\
  \ \ \L\ \/\ \L\.\_/\ \__/\ \ \\`\\ \ \L\ \/\ \L\ \/\ \/\ \/\  __/  __\ \ \_\ \/\ \L\ \
   \ \____/\ \__/.\_\ \____\\ \_\ \_\ \_,__/\ \____/\ \_\ \_\ \____\/\_\\ \____/\ \____/
    \/___/  \/__/\/_/\/____/ \/_/\/_/\/___/  \/___/  \/_/\/_/\/____/\/_/ \/___/  \/___/

Backbone.Do is a plugin to make model actions doable.

Build Status

It can be used normally in any browser as well as in the node.js environment.


Install using the package manager for your desired environment(s):

# for node.js:
$ npm install
# OR; for the browser:
$ bower install

Obviously, this plugin depends on Backbone along with its dependencies.


The API supports both Backbone collections and models. The main difference what data is sent to the server when selected model attributes are sent and how the server response is handled.


Giving your model actions is as simple as adding a new hash and calling this plugin in your model's initialize function. actions can even be a function that returns a hash.

var Book = Backbone.Model.extend({
  urlRoot: '/books',

  actions: {
    buy: {
      data: {
        referrer: 'Amazon',
        method:   'create'

    getPages: {
      url:    'pages',
      attrs:  'pageCount',
      method: 'read'

  initialize: function() {

Now the Book model has the 2 additional functions; buy and getPages which, when called, will result in a request being sent to the server based on their options as well as any data and/or options passed in.

var hobbit = new Book({
  id:        'hobbit',
  title:     'The Hobbit',
  author:    'J.R.R. Tolkien',
  genre:     'fantasy',
  keywords:  [ 'baggins', 'shire' ],
  pageCount: 310
}); {

If the server returns an attribute hash, those values will then be applied to the model. In the previous example the following requests would have been sent to the server:


The first request would have been sent the JSON-formatted data in the request body.

Each action function accepts optional data (to be sent to the server) and options (to configure the action) that can overload the defaults for that action.

var ShoppingCart = Backbone.View.extend({
  events: {
    'click .checkout-btn': 'checkout'

  checkout: function() {{
      quantity: this.$('input.quantity-field').val()

There's a lot of ways in which actions can be declared so let's go over the different configurations. Each configuration can also be a function that returns the value to be used and all are entirely optional. Even the whole action can be a function that returns the configuration hash.

Any other undocumented configurations will simply be passed along to Backbone.sync and, eventually, Backbone.ajax as options. Action functions also support the same asynchronous patterns as Backbone.ajax, whose result is also used as their return value.


Type(s): String String[]

A subset of attributes to be picked from the model and sent to the server. If used on a collection, this is done for each child model of the collection and then that mapping is sent to the server.

Note: If the data configuration is used, this will be ignored.

var Book = Backbone.Model.extend({
  // ...

  actions: {
    // ...

    findRelated: {
      attrs:  'author genre keywords',
      method: 'read'

  defaults: function() {
    return { related: [] };

  // ...


Type(s): Object

JSON-ifiable value that is to be sent to the server in the request body.

Note: If the attrs configuration is used and no data is specified, the resulting attributes hash will replace the populate this value.

var Book = Backbone.Model.extend({
  // ...

  actions: {
    // ...

    loan: {
      data: {
        user: 'golem2013'

  // ...


Type(s): String

The CRUD method to be passed to Backbone.sync. By default this is the value of defaultMethod. This can be any of the following methods;

  • create
  • update
  • patch
  • delete
  • read


Type(s): String

The path to be appended to URL of the model, which is used as the target of the server request. If this is not specified, the parseName function will be called instead to derive an appropriate path based on the action's name.



The default CRUD method used internally by Backbone. This can be any of the same values for the method configuration but, by default, is update.

Backbone.Do.defaultMethod = 'update';


If an action doesn't specify a url, this function will be called to derive a path from it's name.

By default, it simply returns the name with no modifications, but this allows you to customize this behaviour. For example; if you wanted actions with names in camel case to instead use hyphens you could use something like the following;

Backbone.Do.parseName = function(name) {
  return name.replace(/[A-Z]+/g, function(str) {
    return '-' + str.toLowerCase();


The current version of this plugin.



Two different events will be trigger by this plugin:

  • action (model, name, resp, options) - when a model's action has successfully completed
  • action:[name] (model resp, options) - when a specific action has successfully completed


If you have any problems with this library or would like to see the changes currently in development you can do so here;

See the document for more details.


Take a look at docs/ to get a better understanding of what the code is doing.

If that doesn't help, feel free to follow me on Twitter, @neocotic.

However, if you want more information or examples of using this library please visit the project's homepage;