JSData is a framework-agnostic, datastore-agnostic ORM/ODM for Node.js and the Browser.
Adapters allow JSData to connect to various data sources 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.
For Getting Started guides, visit http://js-data.io!
This example shows setting up JSData to use the Http adapter in the browser:
npm i --save js-data js-data-http
See installation instructions for making JSData part of your r.js/browserify/webpack build.
import {DataStore} from 'js-data'
import HttpAdapter from 'js-data-http'
// Create an empty data store
const store = new DataStore()
// "store" will use an http adapter by default
store.registerAdapter('http', new HttpAdapter(), { 'default': true })
// Define a new Mapper for a "user" resource
store.defineMapper('user')
// Get a reference to the store's "user" collection
const Users = store.getCollection('user')
async function showExample () {
let user = await store.find('user', 1)
console.log(user) // { id: 1, name: 'John' }
// The user record is now stored in Users
console.log(Users.get(user.id)) // { id: 1, name: 'John' }
console.log(user === Users.get(user.id)) // true
user.name = 'Johnny'
// PUT /user/1 {name:"Johnny"}
user = await user.save()
// The user record has been updated
console.log(Users.get(user.id)) // { id: 1, name: 'Johnny' }
console.log(user === Users.get(user.id)) // true
await user.destroy()
// The user instance no longer stored in Users
console.log(Users.get(1)) // undefined
}
ES5:
// Create an empty data store
var store = new JSData.DataStore()
// "store" will use an http adapter by default
store.registerAdapter('http', new HttpAdapter(), { default: true })
// Define a new Mapper for a "user" resource
store.defineMapper('user')
// Get a reference to the store's "user" collection
var Users = store.getCollection('user')
store.find('user', 1)
.then(function (user) {
console.log(user) // { id: 1, name: 'John' }
// The user record is now stored in Users
console.log(Users.get(user.id)) // { id: 1, name: 'John' }
console.log(user === Users.get(user.id)) // true
user.name = 'Johnny'
// PUT /user/1 {name:"Johnny"}
return user.save()
})
.then(function (user) {
// The user record has been updated
console.log(Users.get(user.id)) // { id: 1, name: 'Johnny' }
console.log(user === Users.get(user.id)) // true
return user.destroy()
})
.then(function () {
// The user instance no longer stored in Users
console.log(Users.get(1)) // undefined
})
Most ORMs/ODMs only work with a single datastore, most JavaScript ORMs only work in Node.js or the Browser. Wouldn't it be nice if you could use the same ORM/ODM on the client as you do on the backend? Wouldn't it be nice if you could switch databases without having to switch out your data layer code? 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 available for the browser. 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.
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
See an issue with the documentation? Have something to add? Click the "Suggest Edits" button at the top right of each page and make your suggested changes!
Support questions are handled via Stack Overflow, Slack, and the Mailing List. Ask your questions there.
When submitting bug reports or feature requests on GitHub, please include as much detail as possible.
git clone git@github.com:<you>/js-data.gitcd js-datanpm installnpm test (build and test)dist/ folder & files will be generated, do NOT commit dist/*! They
will be committed when a release is cut.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.
3.0.0-alpha.12 - 04 February 2016
FAQs
Robust, framework-agnostic in-memory data store.
The npm package js-data receives a total of 3,943 weekly downloads. As such, js-data popularity was classified as popular.
We found that js-data demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.