https://github.com/jsantell/backbone-promised

Wraps up Backbone's XHR methods into a consistent promisable API
https://github.com/jsantell/backbone-promised

Last synced: 3 months ago
JSON representation

Wraps up Backbone's XHR methods into a consistent promisable API

• Host: GitHub
• URL: https://github.com/jsantell/backbone-promised
• Owner: jsantell
• Created: 2014-03-30T22:33:45.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2016-03-30T09:25:41.000Z (almost 9 years ago)
• Last Synced: 2024-10-08T00:50:06.485Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 161 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# backbone-promised

[![browser support](https://ci.testling.com/jsantell/backbone-promised.png)](https://ci.testling.com/jsantell/backbone-promised)

[![Build Status](http://img.shields.io/travis/jsantell/backbone-promised.svg?style=flat-square)](https://travis-ci.org/jsantell/backbone-promised)

[![Build Status](http://img.shields.io/npm/v/backbone-promised.svg?style=flat-square)](https://www.npmjs.org/package/backbone-promised)

Wraps up Backbone's sync/XHR functions (`Backbone.Model`'s `save`, `fetch`, `destroy` and `Backbone.Collection`'s `fetch`) as promises. If using the native response from these methods, on success, they return a jQuery XHR promisable, on failure a falsy value. This eliminates the need to check to see if it's thennable. Another advantage is these promises return on `options.success` or `options.error`, rather than just the XHR response, so when the modified promises resolve, you can be sure that the collection or model is also updated by that time.

## Install

`npm install backbone-promised`

## Usage

### `BackbonePromised(prototype, resolver)`

`BackbonePromised` takes two arguments; first a prototype (or object) with the methods that

should be extended (`save`, `fetch`, `destroy`). Generally this will be `Backbone.Model.prototype`, but can be any object. The second argument is a Promise resolver so you can use any promise library, as long as you pass in a function that is called with a resolver function, like [when.promise](https://github.com/cujojs/when/blob/master/docs/api.md#whenpromise).

```javascript

var Backbone = require("backbone");

var BackbonePromised = require("backbone-promised");

var when = require("when");

var Model = Backbone.Model.extend(BackbonePromised(Backbone.model.prototype, when.promise));

var user = new Model({ name: "Dash Rendar" });

user.save().then(({ model, options, response }) => {

  console.log("success!", response);

}, ({ model, options, response }) => {

  console.error("rejected!", response);

});

```

## License

MIT License