Nextbone State
State classes for Nextbone Models and Collections.
Usage
Storage
Manage data in a centralized store
Note: Storage class requires a global
Promise
object to exist, please include aPromise
polyfill if necessary. It also uses ES6 classes with class properties feature which may require transpilation
In order to create a new Store extend the Storage
class and set the model and
collection to the correct classes.
;;; static model = Book static collection = Books; var bookStore = ;
find
In order to retrieve a model from the store simply call find()
with an id,
an object with an id, or a model instance with an id. If the model does not
exist in the store, it will be fetched from the server via the model's fetch()
method.
bookStore;
You can optionally pass a boolean forceFetch to ensure a call is made to the backend. Default is false.
bookStore;
findAll
To retrieve the entire collection from the store call findAll()
. If the
collection has not previously been synced it will call the collection's
fetch()
method.
bookStore;
Allows a object 'options' that will get passed to the collection fetch call.
bookStore;
You can optionally pass a boolean forceFetch to ensure a call is made to the backend. Default is false.
bookStore;
save
When you want to save a model back to the server call the save()
method with
the model you wish to save. If the model did not previously exist in the store
it will be inserted.
var book = name: 'Lolita' ;bookStore;
insert
To insert a model into the store without any server interaction use the
insert()
method.
var book = name: 'Invisible Man' ;bookStore;
Resource
Configures REST resource endpoints declaratively
Setup sync handler
; synchandler =
Configure endpoints
; const baseUrl = '/cgi-bin/books.cgi/' const resourceDefs = name: 'book' path: 'books' params: name: 'author' location: 'query' name: 'bookbycategory' path: 'categories/:categoryid/books' params: name: 'categoryid' const resourceClient = baseUrl resourceDefs // configure default resourceClientResourceCollectionresourceClient = resourceClientResourceModelresourceClient = resourceClient
Configure Model/Collection
; static resource = 'book' const books = books // calls /cgi-bin/books.cgi/booksbooksparamsauthor = 'luiz'books // calls /cgi-bin/books.cgi/books?author=luiz
Getting Started
npm install
Running Tests
npm test
===
© 2019 Luiz Américo Pereira Câmara