/orbit-data

fork of @orbit/data

Primary LanguageJavaScriptMIT LicenseMIT

@orbit/data

Applies the primitives from @orbit/core to data sources. Includes the following elements:

  • A schema for defining models, including attributes and relationships.

  • Operations used to manipulate records (e.g. addRecord, removeRecord, addToHasMany, etc.).

  • Transforms, which are composed of any number of operations, and must be performed transactionally.

  • A query language that allows query expressions to be composed in a flexible AST form.

  • A base Source class that can be used to abstract any source of data. Sources can be decorated as pullable, pushable, queryable, syncable, and/or updatable - each decorator provides a unique interface that allows for transforms and queries to be applied as appropriate.

Installation

Install with npm:

npm install @orbit/data

Contributing

Installation

Install the CLI for Broccoli globally:

npm install -g broccoli-cli

Install other dependencies:

npm install

Building

Distributions can be built to the /dist directory by running:

npm run build

Testing

CI Testing

Test in CI mode by running:

npm test

Or directly with testem (useful for configuring options):

testem ci

Browser Testing

Test within a browser (at http://localhost:4200/tests/) by running:

testem

License

Copyright 2014-2017 Cerebris Corporation. MIT License (see LICENSE for details).