# jsonapi-datastore
[![Build Status](https://travis-ci.org/beauby/jsonapi-datastore.svg)](https://travis-ci.org/beauby/jsonapi-datastore)
JavaScript client-side [JSON API](http://jsonapi.org) data handling made easy.
Current version is v0.4.0-beta. It is still a work in progress, but should do what it says.
## Description
The [JSONAPI](http://jsonapi.org) standard is great for exchanging data (which is its purpose), but the format is not ideal to work directly with in an application.
jsonapi-datastore is a JavaScript framework-agnostic library (but an [AngularJS version](#angularjs) is provided for convenience) that takes away the burden of handling [JSONAPI](http://jsonapi.org) data on the client side.
What it does:
- read JSONAPI payloads,
- rebuild the underlying data graph,
- allows you to query models and access their relationships directly,
- create new models,
- serialize models for creation/update.
What it does not do:
- make requests to your API. You design your endpoints URLs, the way you handle authentication, caching, etc. is totally up to you.
## Installing
Install jsonapi-datastore with `bower` by running:
```
$ bower install jsonapi-datastore
```
or with `npm` by running:
```
$ npm install jsonapi-datastore
```
## Parsing data
Just call the `.sync()` method of your store.
```javascript
var store = new JsonApiDataStore();
store.sync(data);
```
This parses the data and incorporates it in the store, taking care of already existing records (by updating them) and relationships.
## Parsing with meta data
If you have meta data in your payload use the `.syncWithMeta` method of your store.
```javascript
var store = new JsonApiDataStore();
store.syncWithMeta(data);
```
This does everything that `.sync()` does, but returns an object with data and meta split.
## Retrieving models
Just call the `.find(type, id)` method of your store.
```javascript
var article = store.find('article', 123);
```
or call the `.findAll(type)` method of your store to get all the models of that type.
```javascript
var articles = store.findAll('article');
```
All the attributes *and* relationships are accessible through the model as object properties.
```javascript
console.log(article.author.name);
```
In case a related resource has not been fetched yet (either as a primary resource or as an included resource), the corresponding property on the model will contain only the `type` and `id` (and the `._placeHolder` property will be set to `true`). However, the models are *updated in place*, so you can fetch a related resource later, and your data will remain consistent.
## Serializing data
Just call the `.serialize()` method on the model.
```javascript
console.log(article.serialize());
```
## Examples
```javascript
// Create a store:
var store = new JsonApiDataStore();
// Then, given the following payload, containing two `articles`, with a related `user` who is the author of both:
var payload = {
data: [{
type: 'article',
id: 1337,
attributes: {
title: 'Cool article'
},
relationships: {
author: {
data: {
type: 'user',
id: 1
}
}
}
}, {
type: 'article',
id: 300,
attributes: {
title: 'Even cooler article'
},
relationships: {
author: {
data: {
type: 'user',
id: 1
}
}
}
}]
};
// we can sync it:
var articles = store.sync(payload);
// which will return the list of synced articles.
// Later, we can retrieve one of those:
var article = store.find('article', 1337);
// If the author resource has not been synced yet, we can only access its id and its type:
console.log(article.author);
// { id: 1, _type: 'article' }
// If we do sync the author resource later:
var authorPayload = {
data: {
type: 'user',
id: 1,
attributes: {
name: 'Lucas'
}
}
};
store.sync(authorPayload);
// we can then access the author's name through our old `article` reference:
console.log(article.author.name);
// 'Lucas'
// We can also serialize any whole model in a JSONAPI-compliant way:
console.log(article.serialize());
// ...
// or just a subset of its attributes/relationships:
console.log(article.serialize({ attributes: ['title'], relationships: []}));
// ...
```
## Documentation
See [DOCUMENTATION.md](DOCUMENTATION.md).
## What's missing
Currently, the store does not handle `links` attributes or resource-level or relationship-level meta.
## Notes
### AngularJS
jsonapi-datastore is bundled with an AngularJs wrapper. Just include `ng-jsonapi-datastore.js` in your `index.html` and require the module `beauby.jsonApiDataStore` in your application.
You can then use the `JsonApiDataStore` factory, which is essentially defined as follows:
```javascript
{
store: new JsonApiDataStore(),
Model: JsonApiDataStoreModel
}
```
so that you can use it as follows:
```javascript
angular
.module('myApp')
.controller('myController', function(JsonApiDataStore) {
var article = JsonApiDataStore.store.find('article', 1337);
var newArticle = new JsonApiDataStore.Model('article');
newArticle.setAttribute('title', 'My cool article');
console.log(newArticle.serialize());
});
```
## Contributing
All pull-requests welcome!
没有合适的资源?快使用搜索试试~ 我知道了~
稻香米商城小程序源码.7z
共50个文件
png:14个
js:11个
wxss:7个
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 168 浏览量
2022-06-23
14:23:55
上传
评论
收藏 66KB 7Z 举报
温馨提示
稻香米商城小程序源码.7z
资源推荐
资源详情
资源评论
收起资源包目录
稻香米商城小程序源码.7z (50个子文件)
稻香米商城
wechat_mall_applet-master
images
ba_active.png 2KB
profile.png 2KB
ba.png 2KB
our_select.png 4KB
packing.png 4KB
new_small.png 2KB
volume_small.png 2KB
1.png 3KB
direct_sale.png 4KB
asset.png 5KB
hot_small.png 1KB
cart_active.png 2KB
cart.png 2KB
profile_active.png 2KB
wechat_mall_applet.sublime-project 302B
License.txt 1KB
app.json 1KB
pages
index
index.js 2KB
index.json 49B
index.wxss 792B
index.wxml 2KB
cart
cart.js 3KB
cart.json 46B
cart.wxss 1KB
cart.wxml 2KB
show_product
show_product.wxml 1KB
show_product.js 1KB
show_product.wxss 754B
address
address.wxml 2KB
address.json 49B
address.js 2KB
address.wxss 493B
category
category.js 1KB
category.wxml 572B
category.wxss 504B
mine
mine.wxss 214B
mine.js 226B
mine.wxml 189B
mine.json 49B
.gitignore 29B
app.wxss 0B
app.js 710B
README.md 533B
utils
jsonapi-datastore
package.json 3KB
dist
jsonapi-datastore.js 8KB
LICENSE.md 1KB
README.md 5KB
product.js 1KB
address.js 697B
address_data.js 49KB
共 50 条
- 1
资源评论
Cheng-Dashi
- 粉丝: 108
- 资源: 1万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功