js-data-http

This repo contains HTTP adapters for js-data:

• js-data-http - HTTP (XHR, includes axios) adapter for js-data in the browser. Capable of using window.fetch instead of axios.
• js-data-fetch - Same as js-data-http but doesn't include axios and will use window.fetch if available and if you don't provide your own http library.
• js-data-http-node - Same as js-data-http but runs on Node.js. Depends on axios and will use axios unless you provide a different http library.

Tested on IE9, Chrome 46, Firefox 41 & Safari 7.1 using

Table of contents

• Quick start
• Dependencies
• Documentation
• API Reference
• Support
• Community
• Contributing
• License

Quick Start

Browser

bower install --save js-data js-data-http or npm install --save js-data js-data-http.

ES6

const adapter = new DSHttpAdapter()

class Base extends JSData.Model {}
Base.registerAdapter('http', adapter, { default: true })

class School extends Model {}
class Student extends Model {}

// "School" and "Student" will now use the http adapter by default

ES5

var adapter = new DSHttpAdapter()

var Base = JSData.Model.extend({}, { name: 'Base' })
Base.registerAdapter('http', adapter, { default: true })

var School = Base.extend({}, { name: 'School' })
var Student = Base.extend({}, { name: 'Student' })

// "School" and "Student" will now use the http adapter by default

Node.js

npm install --save axios js-data js-data-http-node

ES6

import {Model} from 'js-data'
import DSHttpAdapter from 'js-data-http-node'

const adapter = new DSHttpAdapter()

class Base extends Model {}
Base.registerAdapter('http', adapter, { default: true })

class School extends Model {}
class Student extends Model {}

// "School" and "Student" will now use the http adapter by default

ES5

var JSData = require('js-data')
var Model = JSData.Model
var DSHttpAdapter = require('js-data-http-node')

var adapter = new DSHttpAdapter()

var Base = Model.extend({}, { name: 'Base' })
Base.registerAdapter('http', adapter, { default: true })

var School = Base.extend({}, { name: 'School' })
var Student = Base.extend({}, { name: 'Student' })

// "School" and "Student" will now use the http adapter by default

Dependencies

js-data-http bundles axios and depends on js-data. js-data-fetch depends on js-data. js-data-http-node depends on js-data and optionally axios.

See JSData's dependencies.

Documentation

• Getting Started with js-data
• js-data-http
• CHANGELOG.md

API Reference

• DS
• DSHttpAdapter

Support

Support questions are handled via Stack Overflow, Slack, and the Mailing List. Ask your questions there.

Community

• Stack Overflow
• Slack chat
• Announcements
• Mailing List
• Issue Tracker
• GitHub
• Contributing Guide

Contributing

First, support is handled via the Slack Channel and the Mailing List. Ask your questions there.

When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.

• good - Your versions of js-data, js-data-http, etc., relevant console logs/error, code examples that revealed the issue
• better - A plnkr, fiddle, or bin that demonstrates the issue
• best - A Pull Request that fixes the issue, including test coverage for the issue and the fix

Pull Requests

1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
2. Fork js-data-http
3. git clone git@github.com:<you>/js-data-http.git
4. cd js-data-http; npm install;
5. Write your code, including relevant documentation and tests
6. Run npm test (build and test)
7. Your code will be linted and checked for formatting, the tests will be run
8. The dist/ folder & files will be generated, do NOT commit dist/*! They will be committed when a release is cut.
9. Submit your PR and we'll review!
10. Thanks!

License

The MIT License (MIT)

Copyright (c) 2014-2016 Jason Dobry

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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 OR COPYRIGHT HOLDERS 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.