backbone-http/README.md

An HTTP interface for BackboneORM

[![Build Status](https://secure.travis-ci.org/vidigami/backbone-http.png)](http://travis-ci.org/vidigami/backbone-http)

![logo](https://github.com/vidigami/backbone-http/raw/master/media/logo.png)

BackboneHTTP provides an HTTP interface that can be used in the browser or from Node.js by using [Superagent](http://visionmedia.github.io/superagent/).

This allows for a iteration of remote collections from the browser using BackboneORM's unified query syntax and iteration methods.

#### Examples (CoffeeScript)

```coffeescript
class Project extends Backbone.Model
  urlRoot: '/projects'
  sync: require('backbone-http').sync(Project)

# Find all items with is_active = true
Project.find {is_active: true}, (err, projects) ->

# Iterate through all items with is_active = true in batches of 200
Project.each {is_active: true, $each: {fetch: 200}},
  ((project, callback) -> ),
  (err) -> console.log 'Done'

# Stream all items with is_active = true in batches of 200
Project.stream({is_active: true, $each: {fetch: 200}})
  .pipe(new ModelStringifier())
  .on('finish', -> console.log 'Done')
```

#### Examples (JavaScript)

```javascript
var Project = Backbone.Model.extend({
  urlRoot: '/projects'
});
Project.prototype.sync = require('backbone-http').sync(Project);

// Find all items with is_active = true
Project.find({is_active: true}, function(err, projects) {});

// Iterate through all items with is_active = true in batches of 200
Project.each({is_active: true, $each: {fetch: 200}},
  function(project, callback) {},
  function(err) {return console.log('Done');}
);

// Stream all items with is_active = true in batches of 200
Project.stream({is_active: true, $each: {fetch: 200}})
  .pipe(new ModelStringifier())
  .on('finish', function() {return console.log('Done');});
```


Please [checkout the website](http://vidigami.github.io/backbone-orm/backbone-http.html) for installation instructions, examples, documentation, and community!


### For Contributors

To build the library for Node.js:

```
$ npm run
```

To build the library for the browser:

```
$ grunt
```

Please run tests before submitting a pull request.

```
$ npm test
```