vue3-yuanma/packages/reactivity/README.md

20 lines
1.0 KiB
Markdown
Raw Normal View History

2019-08-20 21:58:10 +08:00
# @vue/reactivity
2018-09-19 23:35:38 +08:00
2018-09-20 05:45:19 +08:00
## Usage Note
2018-10-27 03:44:50 +08:00
This package is inlined into Global & Browser ESM builds of user-facing renderers (e.g. `@vue/runtime-dom`), but also published as a package that can be used standalone. The standalone build should not be used alongside a pre-bundled build of a user-facing renderer, as they will have different internal storage for reactivity connections. A user-facing renderer should re-export all APIs from this package.
2018-09-20 05:45:19 +08:00
2019-09-07 00:58:31 +08:00
For full exposed APIs, see `src/index.ts`. You can also run `yarn build reactivity --types` from repo root, which will generate an API report at `temp/reactivity.api.md`.
2018-09-20 05:45:19 +08:00
## Credits
The implementation of this module is inspired by the following prior art in the JavaScript ecosystem:
- [Meteor Tracker](https://docs.meteor.com/api/tracker.html)
2019-08-20 21:58:10 +08:00
- [nx-js/reactivity-util](https://github.com/nx-js/reactivity-util)
2018-09-20 05:45:19 +08:00
- [salesforce/observable-membrane](https://github.com/salesforce/observable-membrane)
## Caveats
- Built-in objects are not observed except for `Map`, `WeakMap`, `Set` and `WeakSet`.