@shadow-js/core 0.1.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/LICENSE +2 -2
- package/README.md +134 -331
- package/dist/dev/action.d.ts +36 -0
- package/dist/dev/action.js +90 -0
- package/dist/dev/action.js.map +1 -0
- package/dist/dev/cache.d.ts +35 -0
- package/dist/dev/cache.js +62 -0
- package/dist/dev/cache.js.map +1 -0
- package/dist/dev/context.d.ts +106 -0
- package/dist/dev/context.js +111 -0
- package/dist/dev/context.js.map +1 -0
- package/dist/dev/effect.d.ts +122 -0
- package/dist/dev/effect.js +111 -0
- package/dist/dev/effect.js.map +1 -0
- package/dist/dev/env.d.ts +29 -0
- package/dist/dev/env.js +31 -0
- package/dist/dev/env.js.map +1 -0
- package/dist/dev/events.d.ts +28 -0
- package/dist/dev/events.js +33 -0
- package/dist/dev/events.js.map +1 -0
- package/dist/dev/extend/index.d.ts +331 -0
- package/dist/dev/extend/index.js +317 -0
- package/dist/dev/extend/index.js.map +1 -0
- package/dist/dev/external-store.d.ts +60 -0
- package/dist/dev/external-store.js +60 -0
- package/dist/dev/external-store.js.map +1 -0
- package/dist/dev/index.d.ts +29 -0
- package/dist/dev/index.js +26 -0
- package/dist/dev/internal/concurrency.d.ts +213 -0
- package/dist/dev/internal/concurrency.js +632 -0
- package/dist/dev/internal/concurrency.js.map +1 -0
- package/dist/dev/internal/devtools.d.ts +71 -0
- package/dist/dev/internal/devtools.js +77 -0
- package/dist/dev/internal/devtools.js.map +1 -0
- package/dist/dev/internal/diagnostics.d.ts +90 -0
- package/dist/dev/internal/diagnostics.js +102 -0
- package/dist/dev/internal/diagnostics.js.map +1 -0
- package/dist/dev/internal/dispose.d.ts +28 -0
- package/dist/dev/internal/dispose.js +49 -0
- package/dist/dev/internal/dispose.js.map +1 -0
- package/dist/dev/internal/flags.js +11 -0
- package/dist/dev/internal/flags.js.map +1 -0
- package/dist/dev/internal/graph.d.ts +233 -0
- package/dist/dev/internal/graph.js +578 -0
- package/dist/dev/internal/graph.js.map +1 -0
- package/dist/dev/internal/hydration-flag.d.ts +33 -0
- package/dist/dev/internal/hydration-flag.js +46 -0
- package/dist/dev/internal/hydration-flag.js.map +1 -0
- package/dist/dev/internal/messages.d.ts +56 -0
- package/dist/dev/internal/messages.js +54 -0
- package/dist/dev/internal/messages.js.map +1 -0
- package/dist/dev/internal/owner.d.ts +142 -0
- package/dist/dev/internal/owner.js +290 -0
- package/dist/dev/internal/owner.js.map +1 -0
- package/dist/dev/internal/queue.js +46 -0
- package/dist/dev/internal/queue.js.map +1 -0
- package/dist/dev/internal/scheduler.d.ts +113 -0
- package/dist/dev/internal/scheduler.js +287 -0
- package/dist/dev/internal/scheduler.js.map +1 -0
- package/dist/dev/internal/state.d.ts +141 -0
- package/dist/dev/internal/state.js +28 -0
- package/dist/dev/internal/state.js.map +1 -0
- package/dist/dev/internal/suspension.d.ts +43 -0
- package/dist/dev/internal/suspension.js +45 -0
- package/dist/dev/internal/suspension.js.map +1 -0
- package/dist/dev/internal/types.d.ts +46 -0
- package/dist/dev/list.d.ts +93 -0
- package/dist/dev/list.js +282 -0
- package/dist/dev/list.js.map +1 -0
- package/dist/dev/memo.d.ts +60 -0
- package/dist/dev/memo.js +41 -0
- package/dist/dev/memo.js.map +1 -0
- package/dist/dev/optimistic.d.ts +26 -0
- package/dist/dev/optimistic.js +45 -0
- package/dist/dev/optimistic.js.map +1 -0
- package/dist/dev/ownership.d.ts +204 -0
- package/dist/dev/ownership.js +261 -0
- package/dist/dev/ownership.js.map +1 -0
- package/dist/dev/props.d.ts +134 -0
- package/dist/dev/props.js +282 -0
- package/dist/dev/props.js.map +1 -0
- package/dist/dev/reaction.d.ts +29 -0
- package/dist/dev/reaction.js +61 -0
- package/dist/dev/reaction.js.map +1 -0
- package/dist/dev/reducer.d.ts +41 -0
- package/dist/dev/reducer.js +39 -0
- package/dist/dev/reducer.js.map +1 -0
- package/dist/dev/refs.d.ts +52 -0
- package/dist/dev/refs.js +58 -0
- package/dist/dev/refs.js.map +1 -0
- package/dist/dev/resource.d.ts +135 -0
- package/dist/dev/resource.js +177 -0
- package/dist/dev/resource.js.map +1 -0
- package/dist/dev/selector.d.ts +34 -0
- package/dist/dev/selector.js +118 -0
- package/dist/dev/selector.js.map +1 -0
- package/dist/dev/signal.d.ts +42 -0
- package/dist/dev/signal.js +39 -0
- package/dist/dev/signal.js.map +1 -0
- package/dist/dev/store/index.d.ts +5 -0
- package/dist/dev/store/index.js +4 -0
- package/dist/dev/store/nodes.js +192 -0
- package/dist/dev/store/nodes.js.map +1 -0
- package/dist/dev/store/proxies.js +160 -0
- package/dist/dev/store/proxies.js.map +1 -0
- package/dist/dev/store/read.d.ts +39 -0
- package/dist/dev/store/read.js +72 -0
- package/dist/dev/store/read.js.map +1 -0
- package/dist/dev/store/reconcile.d.ts +73 -0
- package/dist/dev/store/reconcile.js +186 -0
- package/dist/dev/store/reconcile.js.map +1 -0
- package/dist/dev/store/types.d.ts +106 -0
- package/dist/dev/store/use-store.d.ts +60 -0
- package/dist/dev/store/use-store.js +168 -0
- package/dist/dev/store/use-store.js.map +1 -0
- package/dist/dev/suspense.d.ts +101 -0
- package/dist/dev/suspense.js +45 -0
- package/dist/dev/suspense.js.map +1 -0
- package/dist/dev/transitions.d.ts +77 -0
- package/dist/dev/transitions.js +101 -0
- package/dist/dev/transitions.js.map +1 -0
- package/dist/prod/action.js +2 -0
- package/dist/prod/action.js.map +1 -0
- package/dist/prod/cache.js +2 -0
- package/dist/prod/cache.js.map +1 -0
- package/dist/prod/context.js +2 -0
- package/dist/prod/context.js.map +1 -0
- package/dist/prod/effect.js +2 -0
- package/dist/prod/effect.js.map +1 -0
- package/dist/prod/env.js +2 -0
- package/dist/prod/env.js.map +1 -0
- package/dist/prod/events.js +2 -0
- package/dist/prod/events.js.map +1 -0
- package/dist/prod/extend/index.js +2 -0
- package/dist/prod/extend/index.js.map +1 -0
- package/dist/prod/external-store.js +2 -0
- package/dist/prod/external-store.js.map +1 -0
- package/dist/prod/index.js +1 -0
- package/dist/prod/internal/concurrency.js +2 -0
- package/dist/prod/internal/concurrency.js.map +1 -0
- package/dist/prod/internal/devtools.js +2 -0
- package/dist/prod/internal/devtools.js.map +1 -0
- package/dist/prod/internal/diagnostics.js +2 -0
- package/dist/prod/internal/diagnostics.js.map +1 -0
- package/dist/prod/internal/dispose.js +2 -0
- package/dist/prod/internal/dispose.js.map +1 -0
- package/dist/prod/internal/flags.js +2 -0
- package/dist/prod/internal/flags.js.map +1 -0
- package/dist/prod/internal/graph.js +2 -0
- package/dist/prod/internal/graph.js.map +1 -0
- package/dist/prod/internal/hydration-flag.js +2 -0
- package/dist/prod/internal/hydration-flag.js.map +1 -0
- package/dist/prod/internal/messages.js +2 -0
- package/dist/prod/internal/messages.js.map +1 -0
- package/dist/prod/internal/owner.js +2 -0
- package/dist/prod/internal/owner.js.map +1 -0
- package/dist/prod/internal/queue.js +2 -0
- package/dist/prod/internal/queue.js.map +1 -0
- package/dist/prod/internal/scheduler.js +2 -0
- package/dist/prod/internal/scheduler.js.map +1 -0
- package/dist/prod/internal/state.js +2 -0
- package/dist/prod/internal/state.js.map +1 -0
- package/dist/prod/internal/suspension.js +2 -0
- package/dist/prod/internal/suspension.js.map +1 -0
- package/dist/prod/list.js +2 -0
- package/dist/prod/list.js.map +1 -0
- package/dist/prod/memo.js +2 -0
- package/dist/prod/memo.js.map +1 -0
- package/dist/prod/optimistic.js +2 -0
- package/dist/prod/optimistic.js.map +1 -0
- package/dist/prod/ownership.js +2 -0
- package/dist/prod/ownership.js.map +1 -0
- package/dist/prod/props.js +2 -0
- package/dist/prod/props.js.map +1 -0
- package/dist/prod/reaction.js +2 -0
- package/dist/prod/reaction.js.map +1 -0
- package/dist/prod/reducer.js +2 -0
- package/dist/prod/reducer.js.map +1 -0
- package/dist/prod/refs.js +2 -0
- package/dist/prod/refs.js.map +1 -0
- package/dist/prod/resource.js +2 -0
- package/dist/prod/resource.js.map +1 -0
- package/dist/prod/selector.js +2 -0
- package/dist/prod/selector.js.map +1 -0
- package/dist/prod/signal.js +2 -0
- package/dist/prod/signal.js.map +1 -0
- package/dist/prod/store/index.js +1 -0
- package/dist/prod/store/nodes.js +2 -0
- package/dist/prod/store/nodes.js.map +1 -0
- package/dist/prod/store/proxies.js +2 -0
- package/dist/prod/store/proxies.js.map +1 -0
- package/dist/prod/store/read.js +2 -0
- package/dist/prod/store/read.js.map +1 -0
- package/dist/prod/store/reconcile.js +2 -0
- package/dist/prod/store/reconcile.js.map +1 -0
- package/dist/prod/store/use-store.js +2 -0
- package/dist/prod/store/use-store.js.map +1 -0
- package/dist/prod/suspense.js +2 -0
- package/dist/prod/suspense.js.map +1 -0
- package/dist/prod/transitions.js +2 -0
- package/dist/prod/transitions.js.map +1 -0
- package/dist/server/action.js +2 -0
- package/dist/server/action.js.map +1 -0
- package/dist/server/cache.js +2 -0
- package/dist/server/cache.js.map +1 -0
- package/dist/server/context.js +2 -0
- package/dist/server/context.js.map +1 -0
- package/dist/server/effect.js +2 -0
- package/dist/server/effect.js.map +1 -0
- package/dist/server/env.js +2 -0
- package/dist/server/env.js.map +1 -0
- package/dist/server/events.js +2 -0
- package/dist/server/events.js.map +1 -0
- package/dist/server/extend/index.js +2 -0
- package/dist/server/extend/index.js.map +1 -0
- package/dist/server/external-store.js +2 -0
- package/dist/server/external-store.js.map +1 -0
- package/dist/server/index.js +1 -0
- package/dist/server/internal/concurrency.js +2 -0
- package/dist/server/internal/concurrency.js.map +1 -0
- package/dist/server/internal/devtools.js +2 -0
- package/dist/server/internal/devtools.js.map +1 -0
- package/dist/server/internal/diagnostics.js +2 -0
- package/dist/server/internal/diagnostics.js.map +1 -0
- package/dist/server/internal/dispose.js +2 -0
- package/dist/server/internal/dispose.js.map +1 -0
- package/dist/server/internal/flags.js +2 -0
- package/dist/server/internal/flags.js.map +1 -0
- package/dist/server/internal/graph.js +2 -0
- package/dist/server/internal/graph.js.map +1 -0
- package/dist/server/internal/hydration-flag.js +2 -0
- package/dist/server/internal/hydration-flag.js.map +1 -0
- package/dist/server/internal/messages.js +2 -0
- package/dist/server/internal/messages.js.map +1 -0
- package/dist/server/internal/owner.js +2 -0
- package/dist/server/internal/owner.js.map +1 -0
- package/dist/server/internal/queue.js +2 -0
- package/dist/server/internal/queue.js.map +1 -0
- package/dist/server/internal/scheduler.js +2 -0
- package/dist/server/internal/scheduler.js.map +1 -0
- package/dist/server/internal/state.js +2 -0
- package/dist/server/internal/state.js.map +1 -0
- package/dist/server/internal/suspension.js +2 -0
- package/dist/server/internal/suspension.js.map +1 -0
- package/dist/server/list.js +2 -0
- package/dist/server/list.js.map +1 -0
- package/dist/server/memo.js +2 -0
- package/dist/server/memo.js.map +1 -0
- package/dist/server/optimistic.js +2 -0
- package/dist/server/optimistic.js.map +1 -0
- package/dist/server/ownership.js +2 -0
- package/dist/server/ownership.js.map +1 -0
- package/dist/server/props.js +2 -0
- package/dist/server/props.js.map +1 -0
- package/dist/server/reaction.js +2 -0
- package/dist/server/reaction.js.map +1 -0
- package/dist/server/reducer.js +2 -0
- package/dist/server/reducer.js.map +1 -0
- package/dist/server/refs.js +2 -0
- package/dist/server/refs.js.map +1 -0
- package/dist/server/resource.js +2 -0
- package/dist/server/resource.js.map +1 -0
- package/dist/server/selector.js +2 -0
- package/dist/server/selector.js.map +1 -0
- package/dist/server/signal.js +2 -0
- package/dist/server/signal.js.map +1 -0
- package/dist/server/store/index.js +1 -0
- package/dist/server/store/nodes.js +2 -0
- package/dist/server/store/nodes.js.map +1 -0
- package/dist/server/store/proxies.js +2 -0
- package/dist/server/store/proxies.js.map +1 -0
- package/dist/server/store/read.js +2 -0
- package/dist/server/store/read.js.map +1 -0
- package/dist/server/store/reconcile.js +2 -0
- package/dist/server/store/reconcile.js.map +1 -0
- package/dist/server/store/use-store.js +2 -0
- package/dist/server/store/use-store.js.map +1 -0
- package/dist/server/suspense.js +2 -0
- package/dist/server/suspense.js.map +1 -0
- package/dist/server/transitions.js +2 -0
- package/dist/server/transitions.js.map +1 -0
- package/dist/server-dev/action.js +90 -0
- package/dist/server-dev/action.js.map +1 -0
- package/dist/server-dev/cache.js +62 -0
- package/dist/server-dev/cache.js.map +1 -0
- package/dist/server-dev/context.js +108 -0
- package/dist/server-dev/context.js.map +1 -0
- package/dist/server-dev/effect.js +56 -0
- package/dist/server-dev/effect.js.map +1 -0
- package/dist/server-dev/env.js +31 -0
- package/dist/server-dev/env.js.map +1 -0
- package/dist/server-dev/events.js +33 -0
- package/dist/server-dev/events.js.map +1 -0
- package/dist/server-dev/extend/index.js +317 -0
- package/dist/server-dev/extend/index.js.map +1 -0
- package/dist/server-dev/external-store.js +46 -0
- package/dist/server-dev/external-store.js.map +1 -0
- package/dist/server-dev/index.js +26 -0
- package/dist/server-dev/internal/concurrency.js +633 -0
- package/dist/server-dev/internal/concurrency.js.map +1 -0
- package/dist/server-dev/internal/devtools.js +77 -0
- package/dist/server-dev/internal/devtools.js.map +1 -0
- package/dist/server-dev/internal/diagnostics.js +102 -0
- package/dist/server-dev/internal/diagnostics.js.map +1 -0
- package/dist/server-dev/internal/dispose.js +49 -0
- package/dist/server-dev/internal/dispose.js.map +1 -0
- package/dist/server-dev/internal/flags.js +11 -0
- package/dist/server-dev/internal/flags.js.map +1 -0
- package/dist/server-dev/internal/graph.js +578 -0
- package/dist/server-dev/internal/graph.js.map +1 -0
- package/dist/server-dev/internal/hydration-flag.js +46 -0
- package/dist/server-dev/internal/hydration-flag.js.map +1 -0
- package/dist/server-dev/internal/messages.js +54 -0
- package/dist/server-dev/internal/messages.js.map +1 -0
- package/dist/server-dev/internal/owner.js +290 -0
- package/dist/server-dev/internal/owner.js.map +1 -0
- package/dist/server-dev/internal/queue.js +46 -0
- package/dist/server-dev/internal/queue.js.map +1 -0
- package/dist/server-dev/internal/scheduler.js +287 -0
- package/dist/server-dev/internal/scheduler.js.map +1 -0
- package/dist/server-dev/internal/state.js +28 -0
- package/dist/server-dev/internal/state.js.map +1 -0
- package/dist/server-dev/internal/suspension.js +45 -0
- package/dist/server-dev/internal/suspension.js.map +1 -0
- package/dist/server-dev/list.js +282 -0
- package/dist/server-dev/list.js.map +1 -0
- package/dist/server-dev/memo.js +41 -0
- package/dist/server-dev/memo.js.map +1 -0
- package/dist/server-dev/optimistic.js +45 -0
- package/dist/server-dev/optimistic.js.map +1 -0
- package/dist/server-dev/ownership.js +261 -0
- package/dist/server-dev/ownership.js.map +1 -0
- package/dist/server-dev/props.js +282 -0
- package/dist/server-dev/props.js.map +1 -0
- package/dist/server-dev/reaction.js +61 -0
- package/dist/server-dev/reaction.js.map +1 -0
- package/dist/server-dev/reducer.js +39 -0
- package/dist/server-dev/reducer.js.map +1 -0
- package/dist/server-dev/refs.js +58 -0
- package/dist/server-dev/refs.js.map +1 -0
- package/dist/server-dev/resource.js +176 -0
- package/dist/server-dev/resource.js.map +1 -0
- package/dist/server-dev/selector.js +82 -0
- package/dist/server-dev/selector.js.map +1 -0
- package/dist/server-dev/signal.js +39 -0
- package/dist/server-dev/signal.js.map +1 -0
- package/dist/server-dev/store/index.js +4 -0
- package/dist/server-dev/store/nodes.js +192 -0
- package/dist/server-dev/store/nodes.js.map +1 -0
- package/dist/server-dev/store/proxies.js +160 -0
- package/dist/server-dev/store/proxies.js.map +1 -0
- package/dist/server-dev/store/read.js +72 -0
- package/dist/server-dev/store/read.js.map +1 -0
- package/dist/server-dev/store/reconcile.js +186 -0
- package/dist/server-dev/store/reconcile.js.map +1 -0
- package/dist/server-dev/store/use-store.js +168 -0
- package/dist/server-dev/store/use-store.js.map +1 -0
- package/dist/server-dev/suspense.js +45 -0
- package/dist/server-dev/suspense.js.map +1 -0
- package/dist/server-dev/transitions.js +86 -0
- package/dist/server-dev/transitions.js.map +1 -0
- package/package.json +111 -50
- package/dist/chunk-6Y3CCWOY.js +0 -887
- package/dist/chunk-6Y3CCWOY.js.map +0 -1
- package/dist/chunk-B5FTYDUG.js +0 -3
- package/dist/chunk-B5FTYDUG.js.map +0 -1
- package/dist/index.cjs +0 -2000
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.cts +0 -609
- package/dist/index.d.ts +0 -609
- package/dist/index.js +0 -1094
- package/dist/index.js.map +0 -1
- package/dist/jsx-Bugil6CJ.d.cts +0 -151
- package/dist/jsx-Bugil6CJ.d.ts +0 -151
- package/dist/jsx-dev-runtime.cjs +0 -742
- package/dist/jsx-dev-runtime.cjs.map +0 -1
- package/dist/jsx-dev-runtime.d.cts +0 -2
- package/dist/jsx-dev-runtime.d.ts +0 -2
- package/dist/jsx-dev-runtime.js +0 -4
- package/dist/jsx-dev-runtime.js.map +0 -1
- package/dist/jsx-runtime.cjs +0 -742
- package/dist/jsx-runtime.cjs.map +0 -1
- package/dist/jsx-runtime.d.cts +0 -36
- package/dist/jsx-runtime.d.ts +0 -36
- package/dist/jsx-runtime.js +0 -4
- package/dist/jsx-runtime.js.map +0 -1
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
import { Equals } from "./types.js";
|
|
2
|
+
import { Owner } from "./owner.js";
|
|
3
|
+
//#region src/internal/graph.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* Anything that can be read reactively and notify observers: a signal, a memo, or a custom source
|
|
6
|
+
* of a primitive. Exported from `@shadow-js/core/extend` as `SourceNode`. Read one with
|
|
7
|
+
* {@link track}; after changing it, call {@link markObservers} and `schedule` (or `notify`).
|
|
8
|
+
* @since 1.0.0
|
|
9
|
+
*/
|
|
10
|
+
export interface Source {
|
|
11
|
+
/**
|
|
12
|
+
* The node kind: 0 for a signal and for any custom source, which have no sources of their own; a
|
|
13
|
+
* computation has its own kind. A refresh walks only the sources whose kind is not 0.
|
|
14
|
+
*/
|
|
15
|
+
readonly kind: number;
|
|
16
|
+
/** The current value. */
|
|
17
|
+
value: unknown;
|
|
18
|
+
/**
|
|
19
|
+
* The computations that read this source in their last run, as pairs: an observer, then the index of this source in
|
|
20
|
+
* that observer's `sources`. Null or empty when none. Read it with `observersOf`, which returns the observers alone.
|
|
21
|
+
*/
|
|
22
|
+
observers: Edges<Computation> | null;
|
|
23
|
+
/** Stamp of the last computation run that tracked this source (dedupes repeated reads). */
|
|
24
|
+
stamp: number;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* The edges of one node, stored as pairs in one array: the node on the other side of the edge, then the index of this
|
|
28
|
+
* node's entry in that node's own edge array. One array per side costs half the memory of two parallel ones, and
|
|
29
|
+
* removing an edge stays O(1): the last pair moves into the vacated place and tells its owner where it went.
|
|
30
|
+
*/
|
|
31
|
+
export type Edges<T> = Array<T | number>;
|
|
32
|
+
/**
|
|
33
|
+
* The storage of a signal: its value, its equality and the computations that read it. Exported from
|
|
34
|
+
* `@shadow-js/core/extend` as `SignalNode`; create one with `createSignalNode`, read it with
|
|
35
|
+
* {@link readSignal} and write it with `writeSignal`, which notifies its readers. Build a custom
|
|
36
|
+
* primitive on it the way `useSignal` does.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* import { createSignalNode, readSignal, SignalNode, writeSignal } from "@shadow-js/core/extend";
|
|
40
|
+
*
|
|
41
|
+
* const count = createSignalNode<number>(0, Object.is, "count");
|
|
42
|
+
* writeSignal(count, 1);
|
|
43
|
+
* console.log(readSignal(count), count instanceof SignalNode); // 1 true
|
|
44
|
+
* @see createSignalNode
|
|
45
|
+
* @since 1.0.0
|
|
46
|
+
*/
|
|
47
|
+
export declare class Signal<T = unknown> implements Source {
|
|
48
|
+
/** Always 0, the kind of a signal. */
|
|
49
|
+
readonly kind: number;
|
|
50
|
+
/**
|
|
51
|
+
* The current value. Assigning it directly notifies no one: use `writeSignal`, or call `notify`
|
|
52
|
+
* after the assignment.
|
|
53
|
+
*/
|
|
54
|
+
value: T;
|
|
55
|
+
/** Decides whether a write is a change; `false` treats every write as one. */
|
|
56
|
+
equals: Equals<T>;
|
|
57
|
+
/** The computations that read this signal in their last run, as pairs (see {@link Source.observers}). */
|
|
58
|
+
observers: Edges<Computation> | null;
|
|
59
|
+
/** Stamp of the last computation run that tracked this signal (dedupes repeated reads). */
|
|
60
|
+
stamp: number;
|
|
61
|
+
/**
|
|
62
|
+
* Label shown by devtools and diagnostics.
|
|
63
|
+
* @default undefined (the signal is unnamed)
|
|
64
|
+
*/
|
|
65
|
+
name: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* Creates a signal. Prefer `createSignalNode`, which takes the same arguments.
|
|
68
|
+
* @param value Initial value.
|
|
69
|
+
* @param equals Equality that decides whether a write is a change.
|
|
70
|
+
* @param name Devtools label, or undefined for an unnamed signal.
|
|
71
|
+
*/
|
|
72
|
+
constructor(value: T, equals: Equals<T>, name: string | undefined);
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* A memo or an effect: an owner that reads sources and (for memos) is itself a source. Exported from
|
|
76
|
+
* `@shadow-js/core/extend` as `ComputationNode`; create one with `createComputation` and read a memo
|
|
77
|
+
* with `readComputation`. It owns what its function creates: each run first disposes the children
|
|
78
|
+
* and runs the cleanups of the previous run.
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* import { createComputation, createSignalNode, readComputation, readSignal } from "@shadow-js/core/extend";
|
|
82
|
+
*
|
|
83
|
+
* const price = createSignalNode(10, Object.is);
|
|
84
|
+
* const total = createComputation({ kind: "memo", fn: () => readSignal(price) * 2 });
|
|
85
|
+
* console.log(readComputation<number>(total)); // 20
|
|
86
|
+
* @see createComputation
|
|
87
|
+
* @since 1.0.0
|
|
88
|
+
*/
|
|
89
|
+
export declare class Computation extends Owner implements Source {
|
|
90
|
+
/** 1 for a memo, 2 for an effect. */
|
|
91
|
+
kind: number;
|
|
92
|
+
/** How stale the node is: 0 (clean), 1 (a transitive source changed), 2 (a direct source changed). */
|
|
93
|
+
state: number;
|
|
94
|
+
/** Engine bit flags (queued, running, disposed, render phase, ...). Read-only outside the engine. */
|
|
95
|
+
flags: number;
|
|
96
|
+
/** A memo's last value; an effect's last computed value when it has an `apply` stage. */
|
|
97
|
+
value: unknown;
|
|
98
|
+
/** The error a memo's last run threw, rethrown to its readers; undefined when it succeeded. */
|
|
99
|
+
error: unknown;
|
|
100
|
+
/** A memo's equality: readers are notified only when it says the new value differs. */
|
|
101
|
+
equals: Equals<unknown>;
|
|
102
|
+
/** The function each run calls with the previous value; null once disposed. */
|
|
103
|
+
fn: ((previous: never) => unknown) | null;
|
|
104
|
+
/**
|
|
105
|
+
* An effect's second stage, run untracked with the computed value and the previous one; null for
|
|
106
|
+
* none and once disposed.
|
|
107
|
+
*/
|
|
108
|
+
apply: ((value: never, previous: never) => unknown) | null;
|
|
109
|
+
/**
|
|
110
|
+
* The sources the last run read, in reading order, as pairs: a source, then the index of this computation in that
|
|
111
|
+
* source's `observers`. Read it with `sourcesOf`, which returns the sources alone.
|
|
112
|
+
*/
|
|
113
|
+
sources: Edges<Source>;
|
|
114
|
+
/** The computations that read this memo in their last run, as pairs (see {@link Source.observers}). */
|
|
115
|
+
observers: Edges<Computation> | null;
|
|
116
|
+
/** Stamp of the current run while it tracks, and of the last run that tracked this memo. */
|
|
117
|
+
stamp: number;
|
|
118
|
+
/** During a run: how many leading entries of `sources` were confirmed again (they keep their edges). */
|
|
119
|
+
trackIndex: number;
|
|
120
|
+
/** Creation order; breaks ties between effects at equal depth (G-16). */
|
|
121
|
+
seq: number;
|
|
122
|
+
/**
|
|
123
|
+
* Label shown by devtools and diagnostics.
|
|
124
|
+
* @default undefined (the computation is unnamed)
|
|
125
|
+
*/
|
|
126
|
+
name: string | undefined;
|
|
127
|
+
/**
|
|
128
|
+
* Creates a computation that has not run yet. Prefer `createComputation`, which also runs or
|
|
129
|
+
* queues it.
|
|
130
|
+
* @param parent The owner to attach to, or null.
|
|
131
|
+
* @param kind 1 for a memo, 2 for an effect.
|
|
132
|
+
* @param flags Initial engine bit flags.
|
|
133
|
+
* @param fn The function each run calls.
|
|
134
|
+
* @param equals A memo's equality; `false` for an effect.
|
|
135
|
+
* @param name Devtools label, or undefined.
|
|
136
|
+
*/
|
|
137
|
+
constructor(parent: Owner | null, kind: number, flags: number, fn: (previous: never) => unknown, equals: Equals<unknown>, name: string | undefined);
|
|
138
|
+
protected override reportDisposed(): void;
|
|
139
|
+
protected override release(): void;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Records that the running computation read `source`, so a later {@link markObservers} on it marks
|
|
143
|
+
* that computation stale. Call it in the reader of a custom source; {@link readSignal} does it for
|
|
144
|
+
* signals. Does nothing when untracked, and a source read again in the same run is recorded once.
|
|
145
|
+
*
|
|
146
|
+
* @param source The source that was read.
|
|
147
|
+
* @example
|
|
148
|
+
* import { markObservers, schedule, type SourceNode, track } from "@shadow-js/core/extend";
|
|
149
|
+
*
|
|
150
|
+
* const clock: SourceNode = { kind: 0, value: Date.now(), observers: null, stamp: 0 };
|
|
151
|
+
* export function now(): number {
|
|
152
|
+
* track(clock);
|
|
153
|
+
* return clock.value as number;
|
|
154
|
+
* }
|
|
155
|
+
* setInterval(() => {
|
|
156
|
+
* clock.value = Date.now();
|
|
157
|
+
* markObservers(clock);
|
|
158
|
+
* schedule();
|
|
159
|
+
* }, 1000);
|
|
160
|
+
* @see readSignal
|
|
161
|
+
* @since 1.0.0
|
|
162
|
+
*/
|
|
163
|
+
export declare function track(source: Source): void;
|
|
164
|
+
/**
|
|
165
|
+
* The sources the last run of a computation read, in reading order. Use it to inspect the graph (a debugger, a test);
|
|
166
|
+
* it is a snapshot, so changing the returned array changes no edge.
|
|
167
|
+
*
|
|
168
|
+
* @param node The memo or effect.
|
|
169
|
+
* @returns The signals and memos it reads now.
|
|
170
|
+
* @example
|
|
171
|
+
* import { createComputation, createSignalNode, flushSync, readSignal, sourcesOf } from "@shadow-js/core/extend";
|
|
172
|
+
*
|
|
173
|
+
* const count = createSignalNode<number>(1, Object.is, "count");
|
|
174
|
+
* const effect = createComputation({ kind: "effect", fn: () => void readSignal(count) });
|
|
175
|
+
* flushSync();
|
|
176
|
+
* console.log(sourcesOf(effect).length); // 1
|
|
177
|
+
* @see observersOf
|
|
178
|
+
* @since 1.0.0
|
|
179
|
+
*/
|
|
180
|
+
export declare function sourcesOf(node: Computation): Source[];
|
|
181
|
+
/**
|
|
182
|
+
* The computations that read a signal or memo in their last run, in the order their edges were made. It is a snapshot,
|
|
183
|
+
* so changing the returned array changes no edge. The node's own `observers` array stores pairs (the observer and an
|
|
184
|
+
* index for the engine), so read it through this function.
|
|
185
|
+
*
|
|
186
|
+
* @param source A signal, a memo or a custom source.
|
|
187
|
+
* @returns The memos and effects that read it now.
|
|
188
|
+
* @example
|
|
189
|
+
* import { createComputation, createSignalNode, flushSync, observersOf, readSignal } from "@shadow-js/core/extend";
|
|
190
|
+
*
|
|
191
|
+
* const count = createSignalNode<number>(1, Object.is, "count");
|
|
192
|
+
* createComputation({ kind: "effect", fn: () => void readSignal(count) });
|
|
193
|
+
* flushSync();
|
|
194
|
+
* console.log(observersOf(count).length); // 1
|
|
195
|
+
* @see sourcesOf
|
|
196
|
+
* @since 1.0.0
|
|
197
|
+
*/
|
|
198
|
+
export declare function observersOf(source: Source): Computation[];
|
|
199
|
+
/**
|
|
200
|
+
* Marks the direct observers of a changed source DIRTY and everything downstream CHECK, and queues
|
|
201
|
+
* the effects it reaches. It does not request a flush: call `schedule` afterward, or use `notify`,
|
|
202
|
+
* which does both. Iterative: the graph can be 100,000 nodes deep (G-10).
|
|
203
|
+
*
|
|
204
|
+
* @param source The source whose value changed.
|
|
205
|
+
* @example
|
|
206
|
+
* import { markObservers, schedule, type SignalNode } from "@shadow-js/core/extend";
|
|
207
|
+
*
|
|
208
|
+
* export function push(list: SignalNode<string[]>, item: string): void {
|
|
209
|
+
* list.value.push(item); // same array: writeSignal would see no change
|
|
210
|
+
* markObservers(list);
|
|
211
|
+
* schedule();
|
|
212
|
+
* }
|
|
213
|
+
* @see track
|
|
214
|
+
* @since 1.0.0
|
|
215
|
+
*/
|
|
216
|
+
export declare function markObservers(source: Source): void;
|
|
217
|
+
/**
|
|
218
|
+
* Reads a signal's value, subscribing the running computation to it when one is listening. The
|
|
219
|
+
* reader of a custom primitive built on `createSignalNode`.
|
|
220
|
+
*
|
|
221
|
+
* @param signal The signal to read.
|
|
222
|
+
* @returns The current value.
|
|
223
|
+
* @example
|
|
224
|
+
* import { createSignalNode, readSignal } from "@shadow-js/core/extend";
|
|
225
|
+
*
|
|
226
|
+
* const name = createSignalNode("Ada", Object.is);
|
|
227
|
+
* export const getName = (): string => readSignal(name);
|
|
228
|
+
* @see track
|
|
229
|
+
* @since 1.0.0
|
|
230
|
+
*/
|
|
231
|
+
export declare function readSignal<T>(signal: Signal<T>): T;
|
|
232
|
+
//#endregion
|
|
233
|
+
//# sourceMappingURL=graph.d.ts.map
|