JSPM – js-data-http@3.0.0-alpha.1

Package Exports

js-data-http

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (js-data-http) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

js-data-http

HTTP adapter for js-data.

The js-data-http npm package is for use in the Browser, and the js-data-http-node package is for use in Node.js.

API Documentation

DSHttpAdapter

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

Changelog

CHANGELOG.md

Community

Slack Channel - Better than IRC!
Announcements
Mailing List - Ask your questions!
Issues - Found a bug? Feature request? Submit an issue!
GitHub - View the source code for js-data.
Contributing Guide

Contributing

First, support is handled via the Slack Channel and the [Mailing List][ml]. 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

Github Issues.

Pull Requests

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

License

The MIT License (MIT)

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.