@shadow-js/core 0.1.0 → 1.0.1
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 +17 -0
- package/LICENSE +2 -2
- package/README.md +134 -331
- package/dist/dev/action.d.ts +34 -0
- package/dist/dev/action.js +89 -0
- package/dist/dev/action.js.map +1 -0
- package/dist/dev/cache.d.ts +33 -0
- package/dist/dev/cache.js +61 -0
- package/dist/dev/cache.js.map +1 -0
- package/dist/dev/context.d.ts +104 -0
- package/dist/dev/context.js +110 -0
- package/dist/dev/context.js.map +1 -0
- package/dist/dev/effect.d.ts +120 -0
- package/dist/dev/effect.js +110 -0
- package/dist/dev/effect.js.map +1 -0
- package/dist/dev/env.d.ts +27 -0
- package/dist/dev/env.js +30 -0
- package/dist/dev/env.js.map +1 -0
- package/dist/dev/events.d.ts +26 -0
- package/dist/dev/events.js +32 -0
- package/dist/dev/events.js.map +1 -0
- package/dist/dev/extend/index.d.ts +329 -0
- package/dist/dev/extend/index.js +316 -0
- package/dist/dev/extend/index.js.map +1 -0
- package/dist/dev/external-store.d.ts +58 -0
- package/dist/dev/external-store.js +59 -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 +211 -0
- package/dist/dev/internal/concurrency.js +631 -0
- package/dist/dev/internal/concurrency.js.map +1 -0
- package/dist/dev/internal/devtools.d.ts +69 -0
- package/dist/dev/internal/devtools.js +76 -0
- package/dist/dev/internal/devtools.js.map +1 -0
- package/dist/dev/internal/diagnostics.d.ts +88 -0
- package/dist/dev/internal/diagnostics.js +101 -0
- package/dist/dev/internal/diagnostics.js.map +1 -0
- package/dist/dev/internal/dispose.d.ts +26 -0
- package/dist/dev/internal/dispose.js +48 -0
- package/dist/dev/internal/dispose.js.map +1 -0
- package/dist/dev/internal/flags.js +10 -0
- package/dist/dev/internal/flags.js.map +1 -0
- package/dist/dev/internal/graph.d.ts +231 -0
- package/dist/dev/internal/graph.js +577 -0
- package/dist/dev/internal/graph.js.map +1 -0
- package/dist/dev/internal/hydration-flag.d.ts +31 -0
- package/dist/dev/internal/hydration-flag.js +45 -0
- package/dist/dev/internal/hydration-flag.js.map +1 -0
- package/dist/dev/internal/messages.d.ts +54 -0
- package/dist/dev/internal/messages.js +53 -0
- package/dist/dev/internal/messages.js.map +1 -0
- package/dist/dev/internal/owner.d.ts +140 -0
- package/dist/dev/internal/owner.js +289 -0
- package/dist/dev/internal/owner.js.map +1 -0
- package/dist/dev/internal/queue.js +45 -0
- package/dist/dev/internal/queue.js.map +1 -0
- package/dist/dev/internal/scheduler.d.ts +111 -0
- package/dist/dev/internal/scheduler.js +286 -0
- package/dist/dev/internal/scheduler.js.map +1 -0
- package/dist/dev/internal/state.d.ts +139 -0
- package/dist/dev/internal/state.js +27 -0
- package/dist/dev/internal/state.js.map +1 -0
- package/dist/dev/internal/suspension.d.ts +41 -0
- package/dist/dev/internal/suspension.js +44 -0
- package/dist/dev/internal/suspension.js.map +1 -0
- package/dist/dev/internal/types.d.ts +44 -0
- package/dist/dev/list.d.ts +91 -0
- package/dist/dev/list.js +281 -0
- package/dist/dev/list.js.map +1 -0
- package/dist/dev/memo.d.ts +58 -0
- package/dist/dev/memo.js +40 -0
- package/dist/dev/memo.js.map +1 -0
- package/dist/dev/optimistic.d.ts +24 -0
- package/dist/dev/optimistic.js +44 -0
- package/dist/dev/optimistic.js.map +1 -0
- package/dist/dev/ownership.d.ts +202 -0
- package/dist/dev/ownership.js +260 -0
- package/dist/dev/ownership.js.map +1 -0
- package/dist/dev/props.d.ts +132 -0
- package/dist/dev/props.js +281 -0
- package/dist/dev/props.js.map +1 -0
- package/dist/dev/reaction.d.ts +27 -0
- package/dist/dev/reaction.js +60 -0
- package/dist/dev/reaction.js.map +1 -0
- package/dist/dev/reducer.d.ts +39 -0
- package/dist/dev/reducer.js +38 -0
- package/dist/dev/reducer.js.map +1 -0
- package/dist/dev/refs.d.ts +50 -0
- package/dist/dev/refs.js +57 -0
- package/dist/dev/refs.js.map +1 -0
- package/dist/dev/resource.d.ts +133 -0
- package/dist/dev/resource.js +176 -0
- package/dist/dev/resource.js.map +1 -0
- package/dist/dev/selector.d.ts +32 -0
- package/dist/dev/selector.js +117 -0
- package/dist/dev/selector.js.map +1 -0
- package/dist/dev/signal.d.ts +40 -0
- package/dist/dev/signal.js +38 -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 +191 -0
- package/dist/dev/store/nodes.js.map +1 -0
- package/dist/dev/store/proxies.js +159 -0
- package/dist/dev/store/proxies.js.map +1 -0
- package/dist/dev/store/read.d.ts +37 -0
- package/dist/dev/store/read.js +71 -0
- package/dist/dev/store/read.js.map +1 -0
- package/dist/dev/store/reconcile.d.ts +71 -0
- package/dist/dev/store/reconcile.js +185 -0
- package/dist/dev/store/reconcile.js.map +1 -0
- package/dist/dev/store/types.d.ts +104 -0
- package/dist/dev/store/use-store.d.ts +58 -0
- package/dist/dev/store/use-store.js +167 -0
- package/dist/dev/store/use-store.js.map +1 -0
- package/dist/dev/suspense.d.ts +99 -0
- package/dist/dev/suspense.js +44 -0
- package/dist/dev/suspense.js.map +1 -0
- package/dist/dev/transitions.d.ts +75 -0
- package/dist/dev/transitions.js +100 -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 +89 -0
- package/dist/server-dev/action.js.map +1 -0
- package/dist/server-dev/cache.js +61 -0
- package/dist/server-dev/cache.js.map +1 -0
- package/dist/server-dev/context.js +107 -0
- package/dist/server-dev/context.js.map +1 -0
- package/dist/server-dev/effect.js +55 -0
- package/dist/server-dev/effect.js.map +1 -0
- package/dist/server-dev/env.js +30 -0
- package/dist/server-dev/env.js.map +1 -0
- package/dist/server-dev/events.js +32 -0
- package/dist/server-dev/events.js.map +1 -0
- package/dist/server-dev/extend/index.js +316 -0
- package/dist/server-dev/extend/index.js.map +1 -0
- package/dist/server-dev/external-store.js +45 -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 +632 -0
- package/dist/server-dev/internal/concurrency.js.map +1 -0
- package/dist/server-dev/internal/devtools.js +76 -0
- package/dist/server-dev/internal/devtools.js.map +1 -0
- package/dist/server-dev/internal/diagnostics.js +101 -0
- package/dist/server-dev/internal/diagnostics.js.map +1 -0
- package/dist/server-dev/internal/dispose.js +48 -0
- package/dist/server-dev/internal/dispose.js.map +1 -0
- package/dist/server-dev/internal/flags.js +10 -0
- package/dist/server-dev/internal/flags.js.map +1 -0
- package/dist/server-dev/internal/graph.js +577 -0
- package/dist/server-dev/internal/graph.js.map +1 -0
- package/dist/server-dev/internal/hydration-flag.js +45 -0
- package/dist/server-dev/internal/hydration-flag.js.map +1 -0
- package/dist/server-dev/internal/messages.js +53 -0
- package/dist/server-dev/internal/messages.js.map +1 -0
- package/dist/server-dev/internal/owner.js +289 -0
- package/dist/server-dev/internal/owner.js.map +1 -0
- package/dist/server-dev/internal/queue.js +45 -0
- package/dist/server-dev/internal/queue.js.map +1 -0
- package/dist/server-dev/internal/scheduler.js +286 -0
- package/dist/server-dev/internal/scheduler.js.map +1 -0
- package/dist/server-dev/internal/state.js +27 -0
- package/dist/server-dev/internal/state.js.map +1 -0
- package/dist/server-dev/internal/suspension.js +44 -0
- package/dist/server-dev/internal/suspension.js.map +1 -0
- package/dist/server-dev/list.js +281 -0
- package/dist/server-dev/list.js.map +1 -0
- package/dist/server-dev/memo.js +40 -0
- package/dist/server-dev/memo.js.map +1 -0
- package/dist/server-dev/optimistic.js +44 -0
- package/dist/server-dev/optimistic.js.map +1 -0
- package/dist/server-dev/ownership.js +260 -0
- package/dist/server-dev/ownership.js.map +1 -0
- package/dist/server-dev/props.js +281 -0
- package/dist/server-dev/props.js.map +1 -0
- package/dist/server-dev/reaction.js +60 -0
- package/dist/server-dev/reaction.js.map +1 -0
- package/dist/server-dev/reducer.js +38 -0
- package/dist/server-dev/reducer.js.map +1 -0
- package/dist/server-dev/refs.js +57 -0
- package/dist/server-dev/refs.js.map +1 -0
- package/dist/server-dev/resource.js +175 -0
- package/dist/server-dev/resource.js.map +1 -0
- package/dist/server-dev/selector.js +81 -0
- package/dist/server-dev/selector.js.map +1 -0
- package/dist/server-dev/signal.js +38 -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 +191 -0
- package/dist/server-dev/store/nodes.js.map +1 -0
- package/dist/server-dev/store/proxies.js +159 -0
- package/dist/server-dev/store/proxies.js.map +1 -0
- package/dist/server-dev/store/read.js +71 -0
- package/dist/server-dev/store/read.js.map +1 -0
- package/dist/server-dev/store/reconcile.js +185 -0
- package/dist/server-dev/store/reconcile.js.map +1 -0
- package/dist/server-dev/store/use-store.js +167 -0
- package/dist/server-dev/store/use-store.js.map +1 -0
- package/dist/server-dev/suspense.js +44 -0
- package/dist/server-dev/suspense.js.map +1 -0
- package/dist/server-dev/transitions.js +85 -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 @@
|
|
|
1
|
+
{"version":3,"file":"effect.js","names":[],"sources":["../../src/effect.ts"],"sourcesContent":["import { type Cleanup, createComputation, currentOwner, warn } from \"./extend\";\nimport { untrack } from \"./ownership\";\n\n/**\n * Options of {@link useEffect} in its tracking form `useEffect(fn, options)`.\n * @since 1.0.0\n */\nexport interface EffectOptions {\n /**\n * Label shown by devtools and diagnostics.\n * @default undefined (the effect is unnamed)\n */\n name?: string;\n}\n\n/**\n * Options of {@link useEffect} in its explicit-dependency form `useEffect(deps, fn, options)`.\n * @since 1.0.0\n */\nexport interface DeferredEffectOptions extends EffectOptions {\n /**\n * Skip the first call of `fn`: `deps` is still read (and tracked) on the first run, but `fn` only\n * runs for later changes of it.\n * @default false\n */\n defer?: boolean;\n}\n\n/** What a held effect computes while its gate is closed: nothing for `apply` to act on. */\nconst HELD: unique symbol = Symbol(\"held\");\n\n/** The nearest gate above the current owner (see `Owner.gate`), or null. */\nfunction nearestGate(): (() => boolean) | null {\n for (let owner = currentOwner(); owner !== null; owner = owner.parent) {\n if (owner.gate !== null) return owner.gate;\n }\n return null;\n}\n\nfunction createEffect(\n fnIn: (previous: never) => unknown,\n applyIn: ((value: never, previous: never) => unknown) | null,\n render: boolean,\n deferIn: boolean,\n name: string | undefined,\n): void {\n // Effects never run on the server (G-24): no node, no ownership slot, no cost.\n if (__SERVER__) return;\n if (currentOwner() === null) warn(\"NO_OWNER_EFFECT\");\n let fn = fnIn;\n let apply = applyIn;\n let defer = deferIn;\n const gate = render ? null : nearestGate();\n if (gate !== null) {\n // Held until the gate first opens (a Suspense boundary resolving). The gate is only read until\n // then, so later changes of it never re-run the effect.\n let opened = false;\n const held = (): boolean => {\n if (opened) return false;\n if (gate()) return true;\n opened = true;\n return false;\n };\n if (apply === null) {\n const inner = fn;\n fn = (previous) => (held() ? undefined : inner(previous));\n } else {\n const innerFn = fn;\n const innerApply = apply;\n // `defer` skips the first real run, not the held one, so it is handled here.\n let skipFirst = defer;\n defer = false;\n fn = (previous) => (held() ? HELD : innerFn(previous));\n apply = (value, previous) => {\n if ((value as unknown) === HELD) return undefined;\n if (skipFirst) {\n skipFirst = false;\n return undefined;\n }\n return innerApply(value, ((previous as unknown) === HELD ? undefined : previous) as never);\n };\n }\n }\n createComputation({\n kind: \"effect\",\n fn,\n render,\n defer,\n ...(apply === null ? {} : { apply }),\n ...(name === undefined ? {} : { name }),\n });\n}\n\n/**\n * Runs a side effect after rendering and again whenever a tracked signal changes. The first run\n * is deferred to the next flush. Effects never run on the server. Inside a `<Suspense>` boundary\n * that is still showing its fallback, the first run waits until the boundary first shows its content.\n *\n * Two forms: `useEffect(fn)` tracks everything `fn` reads; `useEffect(deps, fn)` tracks only\n * `deps` and runs `fn` untracked. Return a function to clean up before the next run or disposal.\n * An error thrown by the effect goes to the owner's error handler (`onError`, an error boundary).\n * In development, an effect created outside any owner warns `NO_OWNER_EFFECT`: it still runs, but\n * nothing can dispose it.\n *\n * @param fn The effect. Every signal it reads is tracked. It may return a cleanup function.\n * @param options A devtools name. Undefined uses the default.\n * @example\n * import { useEffect, useSignal } from \"@shadow-js/core\";\n *\n * function PageTitle(props: { unread: number }) {\n * const [title] = useSignal(\"Inbox\");\n * useEffect(() => {\n * document.title = `${title()} (${props.unread})`; // re-runs when either changes\n * });\n * return null;\n * }\n * @see useRenderEffect\n * @see onMount\n * @since 1.0.0\n */\nexport function useEffect(fn: () => void | Cleanup, options?: EffectOptions): void;\n/**\n * Explicit-dependency form of {@link useEffect}: tracks only what `deps` reads, and calls `fn`\n * untracked with the new and the previous value of `deps`. Use it when the effect body reads\n * signals that must not re-run it.\n *\n * @param deps Tracked; its result is passed to `fn`.\n * @param fn Untracked; receives the value of `deps` and its previous value (`undefined` when there\n * is none yet). It may return a cleanup function, which runs before the next call or on disposal.\n * @param options `defer` skips the first call; a devtools name. Undefined uses the defaults.\n * @example\n * import { useEffect } from \"@shadow-js/core\";\n *\n * function Profile(props: { userId: string }) {\n * useEffect(\n * () => props.userId,\n * (next, previous) => console.log(`switched from ${previous} to ${next}`),\n * { defer: true }, // not called for the first id\n * );\n * return null;\n * }\n * @see useEffect\n * @since 1.0.0\n */\nexport function useEffect<T>(\n deps: () => T,\n fn: (value: T, previous: T | undefined) => void | Cleanup,\n options?: DeferredEffectOptions,\n): void;\nexport function useEffect(\n first: () => unknown,\n second?: unknown,\n third?: DeferredEffectOptions,\n): void {\n if (typeof second === \"function\") {\n createEffect(\n first,\n second as (value: never, previous: never) => unknown,\n false,\n third?.defer === true,\n third?.name,\n );\n } else {\n if (Array.isArray(second)) warn(\"EFFECT_DEPS_IGNORED\");\n createEffect(first, null, false, false, (second as EffectOptions | undefined)?.name);\n }\n}\n\n/**\n * Like {@link useEffect} but belongs to the render phase: it runs synchronously when created and\n * before user effects on every flush. Used for DOM bindings; application code rarely needs it.\n * It is not held by a pending `<Suspense>` boundary, and it never runs on the server. In\n * development, one created outside any owner warns `NO_OWNER_EFFECT`.\n *\n * @param compute Tracked; its result is passed to `apply`. Without `apply`, it is the effect itself\n * and may return a cleanup function.\n * @param apply Untracked; receives the value and the previous value (`undefined` on the first\n * run), and may return a cleanup function. Undefined: only `compute` runs.\n * @example\n * import { createRoot, useRenderEffect, useSignal } from \"@shadow-js/core\";\n *\n * const button = document.createElement(\"button\");\n * createRoot(() => {\n * const [label] = useSignal(\"Save\");\n * useRenderEffect(label, (text) => {\n * button.textContent = text; // runs now, and again when label changes\n * });\n * });\n * @see useEffect\n * @since 1.0.0\n */\nexport function useRenderEffect<T>(\n compute: () => T,\n apply?: (value: T, previous: T | undefined) => void | Cleanup,\n): void {\n createEffect(\n compute,\n (apply ?? null) as ((value: never, previous: never) => unknown) | null,\n true,\n false,\n undefined,\n );\n}\n\n/**\n * Runs `fn` once after the owner has been created and flushed, untracked, so signal changes never\n * run it again. Its return value, if a function, is the cleanup, which runs when the owner is\n * disposed. Never runs on the server. Like {@link useEffect}, it waits for a pending `<Suspense>`\n * boundary to show its content, and warns `NO_OWNER_EFFECT` in development outside any owner.\n *\n * @param fn Runs once, untracked. It may return a cleanup function.\n * @example\n * import { onMount } from \"@shadow-js/core\";\n *\n * function SearchBox() {\n * let input: HTMLInputElement | undefined;\n * onMount(() => input?.focus());\n * return <input ref={(el: HTMLInputElement) => (input = el)} />;\n * }\n * @see useEffect\n * @since 1.0.0\n */\nexport function onMount(fn: () => void | Cleanup): void {\n createEffect(() => untrack(fn), null, false, false, \"onMount\");\n}\n"],"mappings":";;;;;AA6BA,MAAM,OAAsB,OAAO,MAAM;;AAGzC,SAAS,cAAsC;CAC7C,KAAK,IAAI,QAAQ,aAAa,GAAG,UAAU,MAAM,QAAQ,MAAM,QAC7D,IAAI,MAAM,SAAS,MAAM,OAAO,MAAM;CAExC,OAAO;AACT;AAEA,SAAS,aACP,MACA,SACA,QACA,SACA,MACM;CAGN,IAAI,aAAa,MAAM,MAAM,KAAK,iBAAiB;CACnD,IAAI,KAAK;CACT,IAAI,QAAQ;CACZ,IAAI,QAAQ;CACZ,MAAM,OAAO,SAAS,OAAO,YAAY;CACzC,IAAI,SAAS,MAAM;EAGjB,IAAI,SAAS;EACb,MAAM,aAAsB;GAC1B,IAAI,QAAQ,OAAO;GACnB,IAAI,KAAK,GAAG,OAAO;GACnB,SAAS;GACT,OAAO;EACT;EACA,IAAI,UAAU,MAAM;GAClB,MAAM,QAAQ;GACd,MAAM,aAAc,KAAK,IAAI,KAAA,IAAY,MAAM,QAAQ;EACzD,OAAO;GACL,MAAM,UAAU;GAChB,MAAM,aAAa;GAEnB,IAAI,YAAY;GAChB,QAAQ;GACR,MAAM,aAAc,KAAK,IAAI,OAAO,QAAQ,QAAQ;GACpD,SAAS,OAAO,aAAa;IAC3B,IAAK,UAAsB,MAAM,OAAO,KAAA;IACxC,IAAI,WAAW;KACb,YAAY;KACZ;IACF;IACA,OAAO,WAAW,OAAS,aAAyB,OAAO,KAAA,IAAY,QAAkB;GAC3F;EACF;CACF;CACA,kBAAkB;EAChB,MAAM;EACN;EACA;EACA;EACA,GAAI,UAAU,OAAO,CAAC,IAAI,EAAE,MAAM;EAClC,GAAI,SAAS,KAAA,IAAY,CAAC,IAAI,EAAE,KAAK;CACvC,CAAC;AACH;AA0DA,SAAgB,UACd,OACA,QACA,OACM;CACN,IAAI,OAAO,WAAW,YACpB,aACE,OACA,QACA,OACA,OAAO,UAAU,MACjB,OAAO,IACT;MACK;EACL,IAAI,MAAM,QAAQ,MAAM,GAAG,KAAK,qBAAqB;EACrD,aAAa,OAAO,MAAM,OAAO,OAAQ,QAAsC,IAAI;CACrF;AACF;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,SAAgB,gBACd,SACA,OACM;CACN,aACE,SACC,SAAS,MACV,MACA,OACA,KAAA,CACF;AACF;;;;;;;;;;;;;;;;;;;AAoBA,SAAgB,QAAQ,IAAgC;CACtD,mBAAmB,QAAQ,EAAE,GAAG,MAAM,OAAO,OAAO,SAAS;AAC/D"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* True in the server condition build, where effects never run and rendering produces strings. Use
|
|
3
|
+
* it to skip browser-only work. The value is fixed per build: the package export conditions
|
|
4
|
+
* (`node`, `worker`, `browser`, ...) choose the build, not a runtime check.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* import { isServer } from "@shadow-js/core";
|
|
8
|
+
*
|
|
9
|
+
* const width = isServer ? 1024 : window.innerWidth;
|
|
10
|
+
* @see isDev
|
|
11
|
+
* @since 1.0.0
|
|
12
|
+
*/
|
|
13
|
+
export declare const isServer: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* True in development builds; false in production builds where `__DEV__` is compiled away. The
|
|
16
|
+
* `development` export condition selects the development build. Use it to guard checks and logging
|
|
17
|
+
* meant for development only.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* import { isDev } from "@shadow-js/core";
|
|
21
|
+
*
|
|
22
|
+
* if (isDev) console.info("debug panel enabled");
|
|
23
|
+
* @see isServer
|
|
24
|
+
* @since 1.0.0
|
|
25
|
+
*/
|
|
26
|
+
export declare const isDev: boolean;
|
|
27
|
+
//# sourceMappingURL=env.d.ts.map
|
package/dist/dev/env.js
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
// src/env.ts
|
|
2
|
+
/**
|
|
3
|
+
* True in the server condition build, where effects never run and rendering produces strings. Use
|
|
4
|
+
* it to skip browser-only work. The value is fixed per build: the package export conditions
|
|
5
|
+
* (`node`, `worker`, `browser`, ...) choose the build, not a runtime check.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* import { isServer } from "@shadow-js/core";
|
|
9
|
+
*
|
|
10
|
+
* const width = isServer ? 1024 : window.innerWidth;
|
|
11
|
+
* @see isDev
|
|
12
|
+
* @since 1.0.0
|
|
13
|
+
*/
|
|
14
|
+
const isServer = false;
|
|
15
|
+
/**
|
|
16
|
+
* True in development builds; false in production builds where `__DEV__` is compiled away. The
|
|
17
|
+
* `development` export condition selects the development build. Use it to guard checks and logging
|
|
18
|
+
* meant for development only.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* import { isDev } from "@shadow-js/core";
|
|
22
|
+
*
|
|
23
|
+
* if (isDev) console.info("debug panel enabled");
|
|
24
|
+
* @see isServer
|
|
25
|
+
* @since 1.0.0
|
|
26
|
+
*/
|
|
27
|
+
const isDev = true;
|
|
28
|
+
export { isDev, isServer };
|
|
29
|
+
|
|
30
|
+
//# sourceMappingURL=env.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"env.js","names":[],"sources":["../../src/env.ts"],"sourcesContent":["/**\n * True in the server condition build, where effects never run and rendering produces strings. Use\n * it to skip browser-only work. The value is fixed per build: the package export conditions\n * (`node`, `worker`, `browser`, ...) choose the build, not a runtime check.\n *\n * @example\n * import { isServer } from \"@shadow-js/core\";\n *\n * const width = isServer ? 1024 : window.innerWidth;\n * @see isDev\n * @since 1.0.0\n */\nexport const isServer: boolean = __SERVER__;\n\n/**\n * True in development builds; false in production builds where `__DEV__` is compiled away. The\n * `development` export condition selects the development build. Use it to guard checks and logging\n * meant for development only.\n *\n * @example\n * import { isDev } from \"@shadow-js/core\";\n *\n * if (isDev) console.info(\"debug panel enabled\");\n * @see isServer\n * @since 1.0.0\n */\nexport const isDev: boolean = __DEV__;\n"],"mappings":";;;;;;;;;;;;;AAYA,MAAa,WAAA;;;;;;;;;;;;;AAcb,MAAa,QAAA"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A stable callback that always runs its handler untracked. The ShadowJS form of React's
|
|
3
|
+
* `useEffectEvent`: components run once and props are getters, so the handler already sees the
|
|
4
|
+
* latest values. What it adds is the untracked call: an effect that calls the event does not
|
|
5
|
+
* subscribe to the signals the handler reads.
|
|
6
|
+
*
|
|
7
|
+
* @param handler The handler. Its arguments and result are passed through.
|
|
8
|
+
* @returns A new function with the same signature that calls `handler` untracked. Create it once,
|
|
9
|
+
* in the component body, and keep the reference.
|
|
10
|
+
* @example
|
|
11
|
+
* import { useEffect, useEvent, useSignal } from "@shadow-js/core";
|
|
12
|
+
*
|
|
13
|
+
* function Ticker() {
|
|
14
|
+
* const [count] = useSignal(0);
|
|
15
|
+
* const onTick = useEvent(() => console.log(count())); // count() is not tracked by the effect
|
|
16
|
+
* useEffect(() => {
|
|
17
|
+
* const id = setInterval(() => onTick(), 1000);
|
|
18
|
+
* return () => clearInterval(id);
|
|
19
|
+
* });
|
|
20
|
+
* return null;
|
|
21
|
+
* }
|
|
22
|
+
* @see untrack
|
|
23
|
+
* @since 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export declare function useEvent<A extends unknown[], R>(handler: (...args: A) => R): (...args: A) => R;
|
|
26
|
+
//# sourceMappingURL=events.d.ts.map
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { untrack } from "./ownership.js";
|
|
2
|
+
// src/events.ts
|
|
3
|
+
/**
|
|
4
|
+
* A stable callback that always runs its handler untracked. The ShadowJS form of React's
|
|
5
|
+
* `useEffectEvent`: components run once and props are getters, so the handler already sees the
|
|
6
|
+
* latest values. What it adds is the untracked call: an effect that calls the event does not
|
|
7
|
+
* subscribe to the signals the handler reads.
|
|
8
|
+
*
|
|
9
|
+
* @param handler The handler. Its arguments and result are passed through.
|
|
10
|
+
* @returns A new function with the same signature that calls `handler` untracked. Create it once,
|
|
11
|
+
* in the component body, and keep the reference.
|
|
12
|
+
* @example
|
|
13
|
+
* import { useEffect, useEvent, useSignal } from "@shadow-js/core";
|
|
14
|
+
*
|
|
15
|
+
* function Ticker() {
|
|
16
|
+
* const [count] = useSignal(0);
|
|
17
|
+
* const onTick = useEvent(() => console.log(count())); // count() is not tracked by the effect
|
|
18
|
+
* useEffect(() => {
|
|
19
|
+
* const id = setInterval(() => onTick(), 1000);
|
|
20
|
+
* return () => clearInterval(id);
|
|
21
|
+
* });
|
|
22
|
+
* return null;
|
|
23
|
+
* }
|
|
24
|
+
* @see untrack
|
|
25
|
+
* @since 1.0.0
|
|
26
|
+
*/
|
|
27
|
+
function useEvent(handler) {
|
|
28
|
+
return (...args) => untrack(() => handler(...args));
|
|
29
|
+
}
|
|
30
|
+
export { useEvent };
|
|
31
|
+
|
|
32
|
+
//# sourceMappingURL=events.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"events.js","names":[],"sources":["../../src/events.ts"],"sourcesContent":["import { untrack } from \"./ownership\";\n\n/**\n * A stable callback that always runs its handler untracked. The ShadowJS form of React's\n * `useEffectEvent`: components run once and props are getters, so the handler already sees the\n * latest values. What it adds is the untracked call: an effect that calls the event does not\n * subscribe to the signals the handler reads.\n *\n * @param handler The handler. Its arguments and result are passed through.\n * @returns A new function with the same signature that calls `handler` untracked. Create it once,\n * in the component body, and keep the reference.\n * @example\n * import { useEffect, useEvent, useSignal } from \"@shadow-js/core\";\n *\n * function Ticker() {\n * const [count] = useSignal(0);\n * const onTick = useEvent(() => console.log(count())); // count() is not tracked by the effect\n * useEffect(() => {\n * const id = setInterval(() => onTick(), 1000);\n * return () => clearInterval(id);\n * });\n * return null;\n * }\n * @see untrack\n * @since 1.0.0\n */\nexport function useEvent<A extends unknown[], R>(handler: (...args: A) => R): (...args: A) => R {\n return (...args: A): R => untrack(() => handler(...args));\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,SAAgB,SAAiC,SAA+C;CAC9F,QAAQ,GAAG,SAAe,cAAc,QAAQ,GAAG,IAAI,CAAC;AAC1D"}
|
|
@@ -0,0 +1,329 @@
|
|
|
1
|
+
import { Accessor, AnyFunction, Cleanup, Equals, ErrorHandler, Setter } from "../internal/types.js";
|
|
2
|
+
import { ContextMap, Owner, addCleanup, handleError } from "../internal/owner.js";
|
|
3
|
+
import { Computation, Signal, Source, markObservers, observersOf, readSignal, sourcesOf, track } from "../internal/graph.js";
|
|
4
|
+
import { batch, flush, flushSync, group, schedule } from "../internal/scheduler.js";
|
|
5
|
+
import { runWithContext } from "../context.js";
|
|
6
|
+
import { BoundaryHold, SlotBranch, SlotChoice, SlotOwned, SlotState, SlotSwap, TransitionHold } from "../internal/state.js";
|
|
7
|
+
import { beginHold, createTransitionHold, endHold, holdReader, inTransition, pauseOwner, registerTransitionLane, resumeOwner, startTransition, transitionHooks, wakeSuspended } from "../internal/concurrency.js";
|
|
8
|
+
import { DEVTOOLS_EVENT, report } from "../internal/devtools.js";
|
|
9
|
+
import { MESSAGES, MessageCode, formatMessage } from "../internal/messages.js";
|
|
10
|
+
import { ShadowError, WarningListener, resetWarningDedupe, setWarningListener, warn } from "../internal/diagnostics.js";
|
|
11
|
+
import { disposeTree } from "../internal/dispose.js";
|
|
12
|
+
import { isHydrating, withHydration } from "../internal/hydration-flag.js";
|
|
13
|
+
import { SUSPENSION, isSuspension } from "../internal/suspension.js";
|
|
14
|
+
/**
|
|
15
|
+
* Returns the owner that adopts nodes created right now. The extension-API form of `getOwner`: use
|
|
16
|
+
* it in a primitive that attaches a node or a cleanup to its caller's owner.
|
|
17
|
+
*
|
|
18
|
+
* @returns The current owner, or `null` outside any owner.
|
|
19
|
+
* @example
|
|
20
|
+
* import { addCleanup, currentOwner } from "@shadow-js/core/extend";
|
|
21
|
+
*
|
|
22
|
+
* function useInterval(fn: () => void, ms: number): void {
|
|
23
|
+
* const timer = setInterval(fn, ms);
|
|
24
|
+
* const owner = currentOwner();
|
|
25
|
+
* if (owner !== null) addCleanup(owner, () => clearInterval(timer));
|
|
26
|
+
* }
|
|
27
|
+
* @see createOwner
|
|
28
|
+
* @since 1.0.0
|
|
29
|
+
*/
|
|
30
|
+
export declare function currentOwner(): Owner | null;
|
|
31
|
+
/**
|
|
32
|
+
* Returns the computation that records reads right now. Use it in a primitive whose read behaves
|
|
33
|
+
* differently for a tracked reader, for example one that holds a boundary only for a listening
|
|
34
|
+
* memo or effect.
|
|
35
|
+
*
|
|
36
|
+
* @returns The listening memo or effect, or `null` when reads are untracked.
|
|
37
|
+
* @example
|
|
38
|
+
* import { currentListener } from "@shadow-js/core/extend";
|
|
39
|
+
*
|
|
40
|
+
* function readWithStats<T>(read: () => T, stats: { tracked: number }): T {
|
|
41
|
+
* if (currentListener() !== null) stats.tracked += 1;
|
|
42
|
+
* return read();
|
|
43
|
+
* }
|
|
44
|
+
* @see isTracking
|
|
45
|
+
* @since 1.0.0
|
|
46
|
+
*/
|
|
47
|
+
export declare function currentListener(): Computation | null;
|
|
48
|
+
/**
|
|
49
|
+
* Says whether reads are being recorded as dependencies right now. Use it to skip subscription
|
|
50
|
+
* work, or to warn, when a primitive is read outside an effect or a memo.
|
|
51
|
+
*
|
|
52
|
+
* @returns `true` while an effect or a memo runs tracked, `false` otherwise (module scope,
|
|
53
|
+
* `untrack`, event handlers).
|
|
54
|
+
* @example
|
|
55
|
+
* import { untrack, useMemo } from "@shadow-js/core";
|
|
56
|
+
* import { isTracking } from "@shadow-js/core/extend";
|
|
57
|
+
*
|
|
58
|
+
* const inMemo = useMemo(() => isTracking());
|
|
59
|
+
* console.log(inMemo(), untrack(() => isTracking())); // true false
|
|
60
|
+
* @see currentListener
|
|
61
|
+
* @since 1.0.0
|
|
62
|
+
*/
|
|
63
|
+
export declare function isTracking(): boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Says whether a memo (not an effect) is computing right now: writing signals is a mistake there.
|
|
66
|
+
* Cleanups that run while a memo tears down rows or children may write, so a disposal in progress
|
|
67
|
+
* is not a violation, and neither is a memo created with `allowWrites`. Use it to guard a custom
|
|
68
|
+
* write path the way {@link writeSignal} does.
|
|
69
|
+
*
|
|
70
|
+
* @returns `true` while a memo without `allowWrites` computes and no disposal is running.
|
|
71
|
+
* @example
|
|
72
|
+
* import { isComputingMemo, ShadowError } from "@shadow-js/core/extend";
|
|
73
|
+
*
|
|
74
|
+
* function appendLog(log: string[], entry: string): void {
|
|
75
|
+
* if (isComputingMemo()) throw new ShadowError("WRITE_IN_MEMO");
|
|
76
|
+
* log.push(entry);
|
|
77
|
+
* }
|
|
78
|
+
* @since 1.0.0
|
|
79
|
+
*/
|
|
80
|
+
export declare function isComputingMemo(): boolean;
|
|
81
|
+
/**
|
|
82
|
+
* Runs `fn` with the given owner and listener in effect, and restores both afterward, even when
|
|
83
|
+
* `fn` throws. The low-level form of `runWithOwner` and `untrack`; unlike `runWithOwner` it does
|
|
84
|
+
* not check whether the owner is disposed.
|
|
85
|
+
*
|
|
86
|
+
* @param scope `owner` and `listener` to install. For each, `undefined` (or absent) keeps the
|
|
87
|
+
* current one and `null` clears it.
|
|
88
|
+
* Getters are evaluated once; a failed getter restores the original scope.
|
|
89
|
+
* @param fn The function to run.
|
|
90
|
+
* @returns Whatever `fn` returns. An error thrown by `fn` propagates after the registers are
|
|
91
|
+
* restored.
|
|
92
|
+
* @example
|
|
93
|
+
* import { onCleanup } from "@shadow-js/core";
|
|
94
|
+
* import { createOwner, disposeOwner, runInScope } from "@shadow-js/core/extend";
|
|
95
|
+
*
|
|
96
|
+
* const owner = createOwner(null);
|
|
97
|
+
* runInScope({ owner, listener: null }, () => {
|
|
98
|
+
* onCleanup(() => console.log("released"));
|
|
99
|
+
* });
|
|
100
|
+
* disposeOwner(owner); // logs "released"
|
|
101
|
+
* @see createOwner
|
|
102
|
+
* @since 1.0.0
|
|
103
|
+
*/
|
|
104
|
+
export declare function runInScope<T>(scope: {
|
|
105
|
+
owner?: Owner | null;
|
|
106
|
+
listener?: Computation | null;
|
|
107
|
+
}, fn: () => T): T;
|
|
108
|
+
/**
|
|
109
|
+
* Creates the storage of a signal: its value, its equality and the observers that read it. Read it
|
|
110
|
+
* with `readSignal` and write it with {@link writeSignal}; `useSignal` is built this way.
|
|
111
|
+
*
|
|
112
|
+
* @param value Initial value.
|
|
113
|
+
* @param equals Decides whether a write is a change: readers are notified only when it returns
|
|
114
|
+
* `false`. `false` notifies on every write.
|
|
115
|
+
* @param name Label shown by devtools. Undefined leaves the signal unnamed.
|
|
116
|
+
* @returns The signal node. It has no owner: it lives as long as something references it.
|
|
117
|
+
* @example
|
|
118
|
+
* import { createSignalNode, readSignal, writeSignal } from "@shadow-js/core/extend";
|
|
119
|
+
*
|
|
120
|
+
* const temperature = createSignalNode<number>(20, Object.is, "temperature");
|
|
121
|
+
* const read = () => readSignal(temperature);
|
|
122
|
+
* writeSignal(temperature, 21);
|
|
123
|
+
* console.log(read()); // 21
|
|
124
|
+
* @see writeSignal
|
|
125
|
+
* @since 1.0.0
|
|
126
|
+
*/
|
|
127
|
+
export declare function createSignalNode<T>(value: T, equals: Equals<T>, name?: string): Signal<T>;
|
|
128
|
+
/**
|
|
129
|
+
* Options of {@link writeSignal}.
|
|
130
|
+
* @since 1.0.0
|
|
131
|
+
*/
|
|
132
|
+
export interface WriteOptions {
|
|
133
|
+
/**
|
|
134
|
+
* Permit the write while a memo computes, for bookkeeping signals owned by a primitive (a
|
|
135
|
+
* Suspense counter, a resource's state). Turns the development `WRITE_IN_MEMO` check off for
|
|
136
|
+
* this write.
|
|
137
|
+
* @default false
|
|
138
|
+
*/
|
|
139
|
+
allowInMemo?: boolean;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Stores a new value in a signal node and notifies its readers when the value differs by the
|
|
143
|
+
* signal's equality. Effects that read it run on the next flush; memos recompute on their next
|
|
144
|
+
* read.
|
|
145
|
+
*
|
|
146
|
+
* @param signal The node, from {@link createSignalNode}.
|
|
147
|
+
* @param next The new value. A function is stored as is: there is no updater form.
|
|
148
|
+
* @param options `allowInMemo` permits the write while a memo computes. Undefined uses the default.
|
|
149
|
+
* @returns `true` when the value changed and was stored, `false` when the equality kept the old
|
|
150
|
+
* value (nobody is notified then).
|
|
151
|
+
* @throws ShadowError `WRITE_IN_MEMO`, in development builds only, when a memo is computing and
|
|
152
|
+
* `allowInMemo` is not set.
|
|
153
|
+
* @example
|
|
154
|
+
* import { createSignalNode, writeSignal } from "@shadow-js/core/extend";
|
|
155
|
+
*
|
|
156
|
+
* const status = createSignalNode<string>("idle", Object.is);
|
|
157
|
+
* console.log(writeSignal(status, "loading")); // true
|
|
158
|
+
* console.log(writeSignal(status, "loading")); // false: an equal value notifies nobody
|
|
159
|
+
* @see notify
|
|
160
|
+
* @since 1.0.0
|
|
161
|
+
*/
|
|
162
|
+
export declare function writeSignal<T>(signal: Signal<T>, next: T, options?: WriteOptions): boolean;
|
|
163
|
+
/**
|
|
164
|
+
* Marks the observers of `source` stale and schedules a flush. Call it after changing a source's
|
|
165
|
+
* value in place (for example after mutating an array a signal node holds), where
|
|
166
|
+
* {@link writeSignal} cannot see the change.
|
|
167
|
+
*
|
|
168
|
+
* @param source A signal or memo node. A source nobody observes is left alone.
|
|
169
|
+
* @example
|
|
170
|
+
* import { createSignalNode, notify } from "@shadow-js/core/extend";
|
|
171
|
+
*
|
|
172
|
+
* const list = createSignalNode<string[]>([], false);
|
|
173
|
+
* list.value.push("milk"); // an in-place change: no equality can see it
|
|
174
|
+
* notify(list); // the readers of `list` run again
|
|
175
|
+
* @see writeSignal
|
|
176
|
+
* @since 1.0.0
|
|
177
|
+
*/
|
|
178
|
+
export declare function notify(source: Source): void;
|
|
179
|
+
/**
|
|
180
|
+
* Options of {@link createComputation}.
|
|
181
|
+
* @since 1.0.0
|
|
182
|
+
*/
|
|
183
|
+
export interface ComputationOptions {
|
|
184
|
+
/**
|
|
185
|
+
* `"memo"` creates a cached value that readers pull with {@link readComputation}; `"effect"`
|
|
186
|
+
* creates a side effect that the scheduler runs.
|
|
187
|
+
*/
|
|
188
|
+
kind: "memo" | "effect";
|
|
189
|
+
/**
|
|
190
|
+
* The computation. It is tracked: every source it reads becomes a dependency. It receives the
|
|
191
|
+
* previous value (a memo's last value, or an effect's last computed value when `apply` is set;
|
|
192
|
+
* `undefined` otherwise). A memo stores its result; an effect without `apply` may return a
|
|
193
|
+
* cleanup function.
|
|
194
|
+
*/
|
|
195
|
+
fn: (previous: never) => unknown;
|
|
196
|
+
/**
|
|
197
|
+
* Memos: decides whether a recomputation changed the value; readers are notified only when it
|
|
198
|
+
* returns `false`, and `false` always propagates. Ignored for effects.
|
|
199
|
+
* @default Object.is
|
|
200
|
+
*/
|
|
201
|
+
equals?: Equals<unknown>;
|
|
202
|
+
/**
|
|
203
|
+
* Label shown by devtools and diagnostics.
|
|
204
|
+
* @default undefined (the node is unnamed)
|
|
205
|
+
*/
|
|
206
|
+
name?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Effects: run in the render phase, synchronously at creation and before user effects in each
|
|
209
|
+
* flush. Ignored for memos.
|
|
210
|
+
* @default false
|
|
211
|
+
*/
|
|
212
|
+
render?: boolean;
|
|
213
|
+
/**
|
|
214
|
+
* Effects with `apply`: skip the first call of `apply`; `fn` still runs and tracks.
|
|
215
|
+
* @default false
|
|
216
|
+
*/
|
|
217
|
+
defer?: boolean;
|
|
218
|
+
/**
|
|
219
|
+
* Memos: do not compute until the first read.
|
|
220
|
+
* @default false (the memo computes once at creation)
|
|
221
|
+
*/
|
|
222
|
+
lazy?: boolean;
|
|
223
|
+
/**
|
|
224
|
+
* Memos that run component setup (such as a hot-reload wrapper): writing signals inside is
|
|
225
|
+
* legitimate there, so the dev-mode write guard stays off.
|
|
226
|
+
* @default false
|
|
227
|
+
*/
|
|
228
|
+
allowWrites?: boolean;
|
|
229
|
+
/**
|
|
230
|
+
* Effects: second stage, run untracked with the value `fn` computed and the previous one. It may
|
|
231
|
+
* return a cleanup function.
|
|
232
|
+
* @default undefined (`fn` is the whole effect)
|
|
233
|
+
*/
|
|
234
|
+
apply?: (value: never, previous: never) => unknown;
|
|
235
|
+
/**
|
|
236
|
+
* Owner to attach to. `null` creates a node that no owner disposes.
|
|
237
|
+
* @default the current owner
|
|
238
|
+
*/
|
|
239
|
+
owner?: Owner | null;
|
|
240
|
+
/**
|
|
241
|
+
* Effects: always run in the transition lane (the watcher behind `useDeferredValue`).
|
|
242
|
+
* @default false
|
|
243
|
+
*/
|
|
244
|
+
lane?: boolean;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Creates a memo or effect node: the building block of `useMemo`, `useEffect` and the render
|
|
248
|
+
* effects of a renderer. Memos compute immediately unless `lazy`; render effects run immediately;
|
|
249
|
+
* user effects are queued for the next flush. The node is owned and disposed with its owner.
|
|
250
|
+
* Errors of a memo are stored and rethrown to its readers; errors of an effect go to the owner's
|
|
251
|
+
* error handler.
|
|
252
|
+
*
|
|
253
|
+
* @param options What to create, how it runs and where it is owned.
|
|
254
|
+
* @returns The node. Read a memo with {@link readComputation}; an effect needs no handle.
|
|
255
|
+
* @throws The error of a render effect's first run when no error handler takes it and no flush is
|
|
256
|
+
* running.
|
|
257
|
+
* @example
|
|
258
|
+
* import { createComputation, createSignalNode, readComputation, readSignal, writeSignal } from "@shadow-js/core/extend";
|
|
259
|
+
*
|
|
260
|
+
* const price = createSignalNode<number>(10, Object.is);
|
|
261
|
+
* const withTax = createComputation({ kind: "memo", fn: () => readSignal(price) * 1.2 });
|
|
262
|
+
* createComputation({
|
|
263
|
+
* kind: "effect",
|
|
264
|
+
* fn: () => console.log(readComputation<number>(withTax)),
|
|
265
|
+
* });
|
|
266
|
+
* writeSignal(price, 20); // the effect logs 24 on the next flush
|
|
267
|
+
* @see readComputation
|
|
268
|
+
* @since 1.0.0
|
|
269
|
+
*/
|
|
270
|
+
export declare function createComputation(options: ComputationOptions): Computation;
|
|
271
|
+
/**
|
|
272
|
+
* Reads a memo node: brings it up to date if a source changed, subscribes the running computation
|
|
273
|
+
* to it, and rethrows the error its last run stored. The accessor `useMemo` returns is this call.
|
|
274
|
+
*
|
|
275
|
+
* @param node A memo node from {@link createComputation}.
|
|
276
|
+
* @returns The memo's current value.
|
|
277
|
+
* @throws The error the memo's last computation threw, when no error handler took it. ShadowError
|
|
278
|
+
* `CYCLE_DETECTED` when the memo is read while it computes.
|
|
279
|
+
* @example
|
|
280
|
+
* import { createComputation, createSignalNode, readComputation, readSignal } from "@shadow-js/core/extend";
|
|
281
|
+
*
|
|
282
|
+
* const first = createSignalNode<string>("Ada", Object.is);
|
|
283
|
+
* const greeting = createComputation({ kind: "memo", fn: () => `Hello, ${readSignal(first)}` });
|
|
284
|
+
* console.log(readComputation<string>(greeting)); // "Hello, Ada"
|
|
285
|
+
* @see createComputation
|
|
286
|
+
* @since 1.0.0
|
|
287
|
+
*/
|
|
288
|
+
export declare function readComputation<T>(node: Computation): T;
|
|
289
|
+
/**
|
|
290
|
+
* Brings a memo or effect node up to date if one of its sources changed, without tracking it. Use
|
|
291
|
+
* it to settle a node before reading its fields directly.
|
|
292
|
+
*
|
|
293
|
+
* @param node A node from {@link createComputation}. A node that is up to date is left as is.
|
|
294
|
+
* @throws ShadowError `CYCLE_DETECTED` when a dependency is still computing (a cycle). An effect
|
|
295
|
+
* that re-runs routes its errors to its owner's error handler.
|
|
296
|
+
* @example
|
|
297
|
+
* import { createComputation, createSignalNode, readSignal, refresh, writeSignal } from "@shadow-js/core/extend";
|
|
298
|
+
*
|
|
299
|
+
* const count = createSignalNode<number>(1, Object.is);
|
|
300
|
+
* const doubled = createComputation({ kind: "memo", fn: () => readSignal(count) * 2 });
|
|
301
|
+
* writeSignal(count, 2);
|
|
302
|
+
* refresh(doubled);
|
|
303
|
+
* console.log(doubled.value); // 4
|
|
304
|
+
* @see readComputation
|
|
305
|
+
* @since 1.0.0
|
|
306
|
+
*/
|
|
307
|
+
export declare function refresh(node: Computation): void;
|
|
308
|
+
/**
|
|
309
|
+
* Creates a plain owner: a scope that adopts the nodes and cleanups created under it and disposes
|
|
310
|
+
* them together. The building block of `createRoot` and of control-flow branches.
|
|
311
|
+
*
|
|
312
|
+
* @param parent The owner to attach to and inherit context from. Undefined (or omitted) uses the
|
|
313
|
+
* current owner; `null` creates a root with no context that only an explicit dispose ends.
|
|
314
|
+
* @returns The new owner. Dispose it with `disposeOwner`.
|
|
315
|
+
* @example
|
|
316
|
+
* import { useEffect } from "@shadow-js/core";
|
|
317
|
+
* import { createOwner, disposeOwner, runInScope } from "@shadow-js/core/extend";
|
|
318
|
+
*
|
|
319
|
+
* const branch = createOwner();
|
|
320
|
+
* runInScope({ owner: branch, listener: null }, () => {
|
|
321
|
+
* useEffect(() => console.log("branch effect"));
|
|
322
|
+
* });
|
|
323
|
+
* disposeOwner(branch); // the effect and its cleanups are gone
|
|
324
|
+
* @see runInScope
|
|
325
|
+
* @since 1.0.0
|
|
326
|
+
*/
|
|
327
|
+
export declare function createOwner(parent?: Owner | null): Owner;
|
|
328
|
+
export { type Accessor, type AnyFunction, type BoundaryHold, type Cleanup, Computation as ComputationNode, type ContextMap, DEVTOOLS_EVENT, type Equals, type ErrorHandler, MESSAGES, type MessageCode, Owner, SUSPENSION, type Setter, ShadowError, Signal as SignalNode, type SlotBranch, type SlotChoice, type SlotOwned, type SlotState, type SlotSwap, type Source as SourceNode, type TransitionHold, type WarningListener, addCleanup, batch, beginHold, createTransitionHold, report as devtoolsReport, disposeTree as disposeOwner, endHold, flush, flushSync, formatMessage, group, handleError, holdReader, inTransition, isHydrating, isSuspension, markObservers, observersOf, pauseOwner, readSignal, registerTransitionLane, resetWarningDedupe, resumeOwner, runWithContext, schedule, setWarningListener, sourcesOf, startTransition, track, transitionHooks, wakeSuspended, warn, withHydration };
|
|
329
|
+
//# sourceMappingURL=index.d.ts.map
|