@pyreon/reactivity 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Vit Bokisch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# @pyreon/reactivity
+
+Signal-based fine-grained reactivity primitives for the Pyreon framework.
+
+## Install
+
+```bash
+bun add @pyreon/reactivity
+```
+
+## Quick Start
+
+```ts
+import { signal, computed, effect, batch } from "@pyreon/reactivity"
+
+const count = signal(0)
+const doubled = computed(() => count() * 2)
+
+effect(() => {
+  console.log("doubled:", doubled())
+})
+
+batch(() => {
+  count.set(1)
+  count.set(2)
+})
+// logs "doubled: 4" once
+```
+
+## API
+
+### Signals
+
+- **`signal<T>(initial: T): Signal<T>`** -- Callable getter with `.set(value)` and `.update(fn)` methods.
+- **`computed<T>(fn, options?): Computed<T>`** -- Derived signal that recomputes lazily when dependencies change.
+- **`cell<T>(initial: T): Cell<T>`** -- Lightweight reactive cell.
+
+### Effects
+
+- **`effect(fn): Effect`** -- Runs `fn` and re-runs it whenever its tracked dependencies change.
+- **`renderEffect(fn): Effect`** -- Like `effect`, but scheduled for render timing.
+- **`watch(source, callback, options?): WatchOptions`** -- Watches a reactive source and calls back on change.
+- **`setErrorHandler(handler)`** -- Sets a global error handler for effect errors.
+
+### Batching
+
+- **`batch(fn)`** -- Groups multiple signal writes; subscribers notified once at the end.
+- **`nextTick(): Promise<void>`** -- Resolves after the current batch of updates flushes.
+
+### Tracking
+
+- **`runUntracked(fn)`** -- Runs `fn` without tracking any signal reads.
+
+### Scopes
+
+- **`effectScope(): EffectScope`** -- Creates a scope that collects effects for bulk disposal.
+- **`getCurrentScope(): EffectScope | undefined`** -- Returns the active effect scope.
+- **`setCurrentScope(scope)`** -- Manually sets the current effect scope.
+
+### Selectors and Resources
+
+- **`createSelector(source)`** -- Creates an efficient selector for keyed comparisons.
+- **`createResource(fetcher): Resource<T>`** -- Wraps an async data source in a reactive resource.
+
+### Stores
+
+- **`createStore(initial)`** -- Creates a deeply reactive store object.
+- **`isStore(value): boolean`** -- Checks whether a value is a reactive store.
+- **`reconcile(target, source)`** -- Efficiently patches a store to match a new value.
+
+## License
+
+MIT