Orbit is a library for coordinating access to data sources and keeping their contents synchronized.
Orbit provides a foundation for building advanced features in client-side applications such as offline operation, maintenance and synchronization of local caches, undo / redo stacks and ad hoc editing contexts.
Support any number of different data sources in an application and provide access to them through common interfaces.
Allow for the fulfillment of requests by different sources, including the ability to specify priority and fallback plans.
Allow records to simultaneously exist in different states across sources.
Coordinate transformations across sources. Handle merges automatically where possible but allow for complete custom control.
Allow for blocking and non-blocking coordination.
Allow for synchronous and asynchronous requests.
Support transactions and rollbacks by tracking operation inverses.
Install with npm:
npm install orbit-core
The original source code is maintained in ES2015 modules in
AMD and CJS builds are in
Orbit.js is dependent upon Immutable.js for immutable data structures.
Orbit defaults to using the global
Promise constructor, if it exists. If your
environment does not implement Promises, or if you wish to use another Promise
implementation, configure your promise library's
Promise constructor as
;;OrbitPromise = RSVPPromise;
Install the CLI for Broccoli globally:
npm install -g broccoli-cli
Install other dependencies:
Distributions can be built to the
/dist directory by running:
npm run build
Test in CI mode by running:
Or directly with testem (useful for configuring options):
Test within a browser (at http://localhost:4200/tests/) by running:
Or directly with
broccoli (useful for configuring the port, etc.):
Generate docs in the
npm run docs
Copyright 2016 Cerebris Corporation. MIT License (see LICENSE for details).