@orbit/core
Version:
Core library for Orbit - a flexible data access and synchronization layer.
70 lines (43 loc) • 1.02 kB
Markdown
# @orbit/core
A core set of primitives for performing, tracking, and responding to
asynchronous tasks, including:
- An event system that allows listeners to engage with the fulfillment of
events by returning promises.
- An asynchronous task processing queue.
- A log that tracks a history of changes and allows for revision and
interrogation.
- A bucket interface for persisting state. Used by logs and queues.
## Installation
Install with yarn:
```
yarn add @orbit/core
```
Or with npm:
```
npm install @orbit/core
```
## Contributing
### Installation
To install dependencies:
```
yarn install
```
### Building
Distributions can be built to the `/dist` directory by running:
```
yarn build
```
### Testing
#### CI Testing
Test in CI mode by running:
```
yarn test
```
#### Browser Testing
Test within a browser
(at [http://localhost:8080/](http://localhost:8080/)) by running:
```
yarn start
```
## License
Copyright 2014-2021 Cerebris Corporation. MIT License (see LICENSE for details).