Package Exports

js-data

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) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JSData

JSData is a datastore-agnostic ORM for Node.js and the Browser.

Adapters allow JSData to connect to various datastores such as Firebase, MySql, RethinkDB, MongoDB, localStorage, Redis, a REST API, etc. With JSData you can re-use your Models between environments, keep your data layer intact when transitioning between app frameworks, and work with a unified data API on the server and the client. JSData employs conventions for rapid development, but allows for endless customization in order to meet your particular needs. Think of it as the "Twitter Bootstrap" of JavaScript data layers.

To get started, check out http://js-data.io!

Quick start
Background
Dependencies
Documentation
API Reference
Support
Community
Contributing
License

Quick Start

js-data + http adapter in the Browser

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

(Substitute js-data-http for any one of the other client-side adapters.)

js-data + http adapter in Node.js

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

(Substitute axios and js-data-http-node for any one of the other server-side adapters.)

See installation instructions for making JSData part of your r.js/browserify/webpack build.

ES2016:

import {Model, registerAdapter} from 'js-data'
import DSHttpAdapter from 'js-data-http'

async function showExample() {
  // "User" will use an http adapter by default
  @registerAdapter('http', new DSHttpAdapter(), { default: true })
  class User extends Model {}

  let user = await User.find(1)

  console.log(user) // { id: 1, name: 'John' }
  console.log(user instanceof User) // true

  // The user instance is now stored in the User Model's collection
  console.log(User.get(user.id)) // { id: 1, name: 'John' }
  console.log(user === User.get(user.id)) // true

  user.name = 'Johnny'

  // PUT /user/1 {name:"Johnny"}
  user = await user.save()

  // The user instance has been updated
  console.log(User.get(user.id)) // { id: 1, name: 'Johnny' }
  console.log(user === User.get(user.id)) // true

  await user.destroy()

  // The user instance no longer stored in User
  console.log(User.get(1)) // undefined
}

showExample()

ES2015:

import {Model, registerAdapter} from 'js-data'
import DSHttpAdapter from 'js-data-http'

function* showExample() {
  class User extends Model {}

  // "User" will use an http adapter by default
  User.registerAdapter('http', new DSHttpAdapter(), { default: true })

  let user = yield User.find(1)

  console.log(user) // { id: 1, name: 'John' }
  console.log(user instanceof User) // true

  // The user instance is now stored in the User Model's collection
  console.log(User.get(user.id)) // { id: 1, name: 'John' }
  console.log(user === User.get(user.id)) // true

  user.name = 'Johnny'

  // PUT /user/1 {name:"Johnny"}
  user = yield user.save()

  // The user instance has been updated
  console.log(User.get(user.id)) // { id: 1, name: 'Johnny' }
  console.log(user === User.get(user.id)) // true

  yield user.destroy()

  // The user instance no longer stored in User
  console.log(User.get(1)) // undefined
}

showExample()

ES5:

var User = JSData.Model.extend({}, { name: 'User' })
// register and use http by default for async operations
User.registerAdapter('http', new DSHttpAdapter(), { default: true });

// Example CRUD operations with default configuration
User.find(1)
  .then(function (user) {
    console.log(user) // { id: 1, name: 'John' }
    console.log(user instanceof User) // true

    // The user instance is now stored in the User Model's collection
    console.log(User.get(user.id)) // { id: 1, name: 'John' }
    console.log(user === User.get(user.id)) // true

    user.name = 'Johnny'

    // PUT /user/1 {name:"Johnny"}
    return user.save()
  })
  .then(function (user) {
    // The user instance has been updated
    console.log(User.get(user.id)) // { id: 1, name: 'Johnny' }
    console.log(user === User.get(user.id)) // true

    // DELETE /user/1
    return user.destroy()
  })
  .then(function () {
    // The user instance no longer stored in User
    console.log(User.get(1)) // undefined
  })

Background

Most ORMs only work with a single datastore. Even when written in JavaScript, most ORMs only work in Node.js or the Browser. Wouldn't it be nice if you could use the same ORM on the client as you do on the backend? Wouldn't it be nice if you could switch databases without having to switch ORMs? Enter JSData.

Originally inspired by the desire to have something like Ember Data that worked in Angular.js and other frameworks, JSData was created. Turns out, JSData works in Node.js, so server-side adapters were written. JSData is the Model layer you've been craving. It consists of a convenient framework-agnostic, datastore-agnostic ORM for managing your data, which uses adapters to connect to various persistence layers.

The most commonly used adapter is the http adapter, which is perfect for connecting your frontend to your backend. localStorage, localForage, Firebase and other adapters are already available. On the server you could hook up to the SQL adapter (Postgres/MySQL/MariaDB/SQLite3) or the MongoDB adapter. More adapters are coming, and you're free to implement your own. See Adapters.

Dependencies

JSData requires the presence of a Promise constructor in the global environment. In the browser, window.Promise must be available. In Node.js, global.Promise must be available. Here is a handy library for polyfilling: https://github.com/jakearchibald/es6-promise.

JSData also requires full ES5 support from the runtime. Here is a handy library for polyfilling: https://github.com/afarkas/html5shiv

Documentation

See an issue with the documentation? Have something to add? Click the "Suggest Edits" at the top right of each page and make your suggested changes!

API Reference

Support

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

Community

Contributing

When submitting bug reports or feature requests on GitHub, please include as much detail as possible.

good - Your versions of Angular, JSData, etc, relevant console logs, stack traces, code examples that revealed the issue, etc.
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

Contribute to the issue/discussion that is the reason you'll be developing in the first place
Fork js-data
git clone git@github.com:<you>/js-data.git
cd js-data; npm 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.

js-data