Reactivity

Framework agnostic library for building reactive applications.

Warning

The APIs implemented in this repository are still under active development and may change based on feedback.

Reactivity-API

Packages developed in this repository:

• @conterra/reactivity-core: Core reactivity library.
• @conterra/reactivity-events: Emitting and subscribing to events.

View API docs:

• Latest release
• Current main brach

Setup

Install pnpm, for example by running npm install -g pnpm.

Install dependencies:

$ pnpm install

Build all packages:

$ pnpm build

Tests

# Runs all tests
$ pnpm test

# Runs tests for a specific package (or file path)
$ pnpm test packages/reactivity-core

Watch TypeScript errors:

$ pnpm watch-types

When developing features across package boundaries, use the dev script in your dependencies. This way, they will be rebuilt automatically:

$ cd packages/reactivity-core
$ pnpm dev

Playground

You can try this library together with Vue3 in the playground directory. See README for more details.

Render typedoc

Build typedoc output (to dist/docs).

$ pnpm build-docs

Then, use any local web server to serve the documentation. The following example uses serve:

$ pnpm install -g serve # global installation; only necessary once
$ serve dist/docs

Releasing

This repository uses Changesets to manage changes. Before releasing, make sure that all pending changes are properly documented using changeset files.

Then, review and merge the current release pull request. The commit created by the merge will in turn publish the packages to npm.

License

Apache-2.0 (see LICENSE file)