From 6ac3b74309b09348440558f6e9b5c0d81fa0c2b6 Mon Sep 17 00:00:00 2001 From: Aria Minaei Date: Thu, 10 Aug 2023 13:48:06 +0200 Subject: [PATCH] Better formatting for dataverse' docs --- packages/dataverse/README.md | 2 +- packages/dataverse/api/README.md | 53 ++---- packages/dataverse/api/classes/Atom.md | 147 ++--------------- .../dataverse/api/classes/PointerProxy.md | 28 +--- packages/dataverse/api/classes/Ticker.md | 155 +----------------- .../api/interfaces/PointerToPrismProvider.md | 2 +- packages/dataverse/api/interfaces/Prism-1.md | 12 +- packages/dataverse/api/modules/prism.md | 18 +- packages/dataverse/typedoc.json | 23 +++ 9 files changed, 75 insertions(+), 365 deletions(-) create mode 100644 packages/dataverse/typedoc.json diff --git a/packages/dataverse/README.md b/packages/dataverse/README.md index 2631230..7a779a9 100644 --- a/packages/dataverse/README.md +++ b/packages/dataverse/README.md @@ -630,7 +630,7 @@ unsub() unsub = sum.onStale(() => {}) // there is now a subscription to `sum`, so it goes 🔥 hot, and so do its dependencies // a | b | sum | -// 🔥🪵 | 🔥🪵 | 🔥🪵 | +// 🔥🪵 | 🔥🪵 | 🔥🪵 | val(sum) // reading the value of `sum` will cause it to recalculate, and make it 🌲 fresh. diff --git a/packages/dataverse/api/README.md b/packages/dataverse/api/README.md index 3996f23..00e7609 100644 --- a/packages/dataverse/api/README.md +++ b/packages/dataverse/api/README.md @@ -52,21 +52,6 @@ explanation of pointers. Atom -**`Remarks`** - -The Pointer type is quite tricky because it doesn't play well with `any` and other inexact types. -Here is an example that one would expect to work, but currently doesn't: -```ts -declare function expectAnyPointer(pointer: Pointer): void - -expectAnyPointer(null as Pointer<{}>) // this shows as a type error because Pointer<{}> is not assignable to Pointer, even though it should -``` - -The current solution is to just avoid using `any` with pointer-related code (or type-test it well). -But if you enjoy solving typescript puzzles, consider fixing this :) -Potentially, [TypeScript variance annotations in 4.7+](https://devblogs.microsoft.com/typescript/announcing-typescript-4-7-beta/#optional-variance-annotations-for-type-parameters) -might be able to help us. - #### Type parameters | Name | @@ -75,7 +60,7 @@ might be able to help us. #### Defined in -[pointer.ts:64](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/pointer.ts#L64) +[pointer.ts:64](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/pointer.ts#L64) ___ @@ -92,7 +77,7 @@ ___ #### Defined in -[pointer.ts:5](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/pointer.ts#L5) +[pointer.ts:5](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/pointer.ts#L5) ___ @@ -116,7 +101,7 @@ A wrapper type for the type a `Pointer` points to. #### Defined in -[pointer.ts:35](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/pointer.ts#L35) +[pointer.ts:35](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/pointer.ts#L35) ## Functions @@ -157,7 +142,7 @@ const {root, path} = getPointerParts(pointer) #### Defined in -[pointer.ts:136](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/pointer.ts#L136) +[pointer.ts:136](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/pointer.ts#L136) ___ @@ -179,7 +164,7 @@ p is Pointer #### Defined in -[pointer.ts:187](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/pointer.ts#L187) +[pointer.ts:187](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/pointer.ts#L187) ___ @@ -201,7 +186,7 @@ d is Prism #### Defined in -[prism/Interface.ts:66](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/Interface.ts#L66) +[prism/Interface.ts:66](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/Interface.ts#L66) ___ @@ -227,7 +212,7 @@ ___ #### Defined in -[prism/iterateAndCountTicks.ts:7](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/iterateAndCountTicks.ts#L7) +[prism/iterateAndCountTicks.ts:7](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/iterateAndCountTicks.ts#L7) ___ @@ -253,7 +238,7 @@ ___ #### Defined in -[prism/iterateOver.ts:8](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/iterateOver.ts#L8) +[prism/iterateOver.ts:8](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/iterateOver.ts#L8) ___ @@ -281,15 +266,6 @@ Creates a pointer to a (nested) property of an [Atom](classes/Atom.md). [`Pointer`](README.md#pointer)<`O`\> -**`Remarks`** - -Pointers are used to make prisms of properties or nested properties of -Atom|Atoms. - -Pointers also allow easy construction of new pointers pointing to nested members -of the root object, by simply using property chaining. E.g. `somePointer.a.b` will -create a new pointer that has `'a'` and `'b'` added to the path of `somePointer`. - **`Example`** ```ts @@ -307,7 +283,7 @@ const sum = prism(() => { #### Defined in -[pointer.ts:172](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/pointer.ts#L172) +[pointer.ts:172](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/pointer.ts#L172) ___ @@ -336,7 +312,7 @@ cached per pointer. #### Defined in -[pointerToPrism.ts:41](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/pointerToPrism.ts#L41) +[pointerToPrism.ts:41](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/pointerToPrism.ts#L41) ___ @@ -365,7 +341,7 @@ in it as dependencies, and reruns the function when these change. #### Defined in -[prism/prism.ts:817](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L817) +[prism/prism.ts:817](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L817) ___ @@ -392,11 +368,6 @@ is a pointer, a prism or a plain value itself. `P` extends [`PointerType`](README.md#pointertype)<`T`\> ? `T` : `P` extends [`Prism`](interfaces/Prism-1.md)<`T`\> ? `T` : `P` extends `undefined` \| ``null`` ? `P` : `unknown` -**`Remarks`** - -For pointers, the value is returned by first creating a prism, so it is -reactive e.g. when used in a `prism`. - #### Defined in -[val.ts:19](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/val.ts#L19) +[val.ts:19](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/val.ts#L19) diff --git a/packages/dataverse/api/classes/Atom.md b/packages/dataverse/api/classes/Atom.md index 33e1ef8..e603af1 100644 --- a/packages/dataverse/api/classes/Atom.md +++ b/packages/dataverse/api/classes/Atom.md @@ -22,17 +22,11 @@ Wraps an object whose (sub)properties can be individually tracked. ### Properties -- [\_currentState](Atom.md#_currentstate) -- [\_rootScope](Atom.md#_rootscope) - [pointer](Atom.md#pointer) - [prism](Atom.md#prism) ### Methods -- [\_checkUpdates](Atom.md#_checkupdates) -- [\_getIn](Atom.md#_getin) -- [\_getOrCreateScopeForPath](Atom.md#_getorcreatescopeforpath) -- [\_onPointerValueChange](Atom.md#_onpointervaluechange) - [get](Atom.md#get) - [getByPointer](Atom.md#getbypointer) - [pointerToPrism](Atom.md#pointertoprism) @@ -61,43 +55,19 @@ Wraps an object whose (sub)properties can be individually tracked. #### Defined in -[Atom.ts:119](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L119) +[Atom.ts:119](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L119) ## Properties -### \_currentState - -• `Private` **\_currentState**: `State` - -#### Defined in - -[Atom.ts:101](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L101) - -___ - -### \_rootScope - -• `Private` `Readonly` **\_rootScope**: `Scope` - -#### Defined in - -[Atom.ts:106](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L106) - -___ - ### pointer • `Readonly` **pointer**: [`Pointer`](../README.md#pointer)<`State`\> Convenience property that gives you a pointer to the root of the atom. -**`Remarks`** - -Equivalent to `pointer({ root: thisAtom, path: [] })`. - #### Defined in -[Atom.ts:113](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L113) +[Atom.ts:113](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L113) ___ @@ -107,107 +77,10 @@ ___ #### Defined in -[Atom.ts:115](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L115) +[Atom.ts:115](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L115) ## Methods -### \_checkUpdates - -▸ `Private` **_checkUpdates**(`scope`, `oldState`, `newState`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `scope` | `Scope` | -| `oldState` | `unknown` | -| `newState` | `unknown` | - -#### Returns - -`void` - -#### Defined in - -[Atom.ts:218](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L218) - -___ - -### \_getIn - -▸ `Private` **_getIn**(`path`): `unknown` - -Gets the state of the atom at `path`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | (`string` \| `number`)[] | - -#### Returns - -`unknown` - -#### Defined in - -[Atom.ts:166](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L166) - -___ - -### \_getOrCreateScopeForPath - -▸ `Private` **_getOrCreateScopeForPath**(`path`): `Scope` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | (`string` \| `number`)[] | - -#### Returns - -`Scope` - -#### Defined in - -[Atom.ts:240](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L240) - -___ - -### \_onPointerValueChange - -▸ `Private` **_onPointerValueChange**<`P`\>(`pointer`, `cb`): () => `void` - -#### Type parameters - -| Name | -| :------ | -| `P` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `pointer` | [`Pointer`](../README.md#pointer)<`P`\> | -| `cb` | (`v`: `P`) => `void` | - -#### Returns - -`fn` - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -[Atom.ts:248](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L248) - -___ - ### get ▸ **get**(): `State` @@ -218,7 +91,7 @@ ___ #### Defined in -[Atom.ts:136](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L136) +[Atom.ts:136](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L136) ___ @@ -246,7 +119,7 @@ Returns the value at the given pointer #### Defined in -[Atom.ts:152](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L152) +[Atom.ts:152](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L152) ___ @@ -278,7 +151,7 @@ Returns a new prism of the value at the provided path. #### Defined in -[Atom.ts:271](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L271) +[Atom.ts:271](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L271) ___ @@ -298,7 +171,7 @@ ___ #### Defined in -[Atom.ts:170](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L170) +[Atom.ts:170](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L170) ___ @@ -327,7 +200,7 @@ Reduces the value at the given pointer #### Defined in -[Atom.ts:186](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L186) +[Atom.ts:186](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L186) ___ @@ -349,7 +222,7 @@ Sets the state of the atom. #### Defined in -[Atom.ts:129](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L129) +[Atom.ts:129](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L129) ___ @@ -378,4 +251,4 @@ Sets the value at the given pointer #### Defined in -[Atom.ts:211](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Atom.ts#L211) +[Atom.ts:211](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Atom.ts#L211) diff --git a/packages/dataverse/api/classes/PointerProxy.md b/packages/dataverse/api/classes/PointerProxy.md index 5275a3a..d9159f9 100644 --- a/packages/dataverse/api/classes/PointerProxy.md +++ b/packages/dataverse/api/classes/PointerProxy.md @@ -4,11 +4,6 @@ Allows creating pointer-prisms where the pointer can be switched out. -**`Remarks`** - -This allows reacting not just to value changes at a certain pointer, but changes -to the proxied pointer too. - ## Type parameters | Name | Type | @@ -27,7 +22,6 @@ to the proxied pointer too. ### Properties -- [\_currentPointerBox](PointerProxy.md#_currentpointerbox) - [pointer](PointerProxy.md#pointer) ### Methods @@ -55,33 +49,19 @@ to the proxied pointer too. #### Defined in -[PointerProxy.ts:34](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/PointerProxy.ts#L34) +[PointerProxy.ts:34](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/PointerProxy.ts#L34) ## Properties -### \_currentPointerBox - -• `Private` `Readonly` **\_currentPointerBox**: [`Atom`](Atom.md)<[`Pointer`](../README.md#pointer)<`O`\>\> - -#### Defined in - -[PointerProxy.ts:25](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/PointerProxy.ts#L25) - -___ - ### pointer • `Readonly` **pointer**: [`Pointer`](../README.md#pointer)<`O`\> Convenience pointer pointing to the root of this PointerProxy. -**`Remarks`** - -Allows convenient use of [pointerToPrism](PointerProxy.md#pointertoprism) and [val](../README.md#val). - #### Defined in -[PointerProxy.ts:32](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/PointerProxy.ts#L32) +[PointerProxy.ts:32](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/PointerProxy.ts#L32) ## Methods @@ -113,7 +93,7 @@ Returns a prism of the value at the provided sub-path of the proxied pointer. #### Defined in -[PointerProxy.ts:52](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/PointerProxy.ts#L52) +[PointerProxy.ts:52](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/PointerProxy.ts#L52) ___ @@ -135,4 +115,4 @@ Sets the underlying pointer. #### Defined in -[PointerProxy.ts:43](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/PointerProxy.ts#L43) +[PointerProxy.ts:43](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/PointerProxy.ts#L43) diff --git a/packages/dataverse/api/classes/Ticker.md b/packages/dataverse/api/classes/Ticker.md index f17e6a0..1930905 100644 --- a/packages/dataverse/api/classes/Ticker.md +++ b/packages/dataverse/api/classes/Ticker.md @@ -14,13 +14,6 @@ external scheduling strategy, e.g. a raf. ### Properties - [\_\_ticks](Ticker.md#__ticks) -- [\_conf](Ticker.md#_conf) -- [\_dormant](Ticker.md#_dormant) -- [\_numberOfDormantTicks](Ticker.md#_numberofdormantticks) -- [\_scheduledForNextTick](Ticker.md#_scheduledfornexttick) -- [\_scheduledForThisOrNextTick](Ticker.md#_scheduledforthisornexttick) -- [\_ticking](Ticker.md#_ticking) -- [\_timeAtCurrentTick](Ticker.md#_timeatcurrenttick) ### Accessors @@ -29,9 +22,6 @@ external scheduling strategy, e.g. a raf. ### Methods -- [\_goActive](Ticker.md#_goactive) -- [\_goDormant](Ticker.md#_godormant) -- [\_tick](Ticker.md#_tick) - [offNextTick](Ticker.md#offnexttick) - [offThisOrNextTick](Ticker.md#offthisornexttick) - [onNextTick](Ticker.md#onnexttick) @@ -54,7 +44,7 @@ external scheduling strategy, e.g. a raf. #### Defined in -[Ticker.ts:43](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L43) +[Ticker.ts:43](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L43) ## Properties @@ -70,86 +60,7 @@ Consider this as experimental, and do not rely on it always being here in future #### Defined in -[Ticker.ts:41](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L41) - -___ - -### \_conf - -• `Private` `Optional` **\_conf**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `onActive?` | () => `void` | -| `onDormant?` | () => `void` | - -#### Defined in - -[Ticker.ts:44](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L44) - -___ - -### \_dormant - -• `Private` **\_dormant**: `boolean` = `true` - -Whether the Ticker is dormant - -#### Defined in - -[Ticker.ts:24](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L24) - -___ - -### \_numberOfDormantTicks - -• `Private` **\_numberOfDormantTicks**: `number` = `0` - -#### Defined in - -[Ticker.ts:26](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L26) - -___ - -### \_scheduledForNextTick - -• `Private` **\_scheduledForNextTick**: `Set`<`ICallback`\> - -#### Defined in - -[Ticker.ts:17](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L17) - -___ - -### \_scheduledForThisOrNextTick - -• `Private` **\_scheduledForThisOrNextTick**: `Set`<`ICallback`\> - -#### Defined in - -[Ticker.ts:16](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L16) - -___ - -### \_ticking - -• `Private` **\_ticking**: `boolean` = `false` - -#### Defined in - -[Ticker.ts:19](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L19) - -___ - -### \_timeAtCurrentTick - -• `Private` **\_timeAtCurrentTick**: `number` - -#### Defined in - -[Ticker.ts:18](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L18) +[Ticker.ts:41](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L41) ## Accessors @@ -165,7 +76,7 @@ Whether the Ticker is dormant #### Defined in -[Ticker.ts:31](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L31) +[Ticker.ts:31](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L31) ___ @@ -182,58 +93,10 @@ The time at the start of the current tick if there is a tick in progress, otherw #### Defined in -[Ticker.ts:122](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L122) +[Ticker.ts:122](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L122) ## Methods -### \_goActive - -▸ `Private` **_goActive**(): `void` - -#### Returns - -`void` - -#### Defined in - -[Ticker.ts:128](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L128) - -___ - -### \_goDormant - -▸ `Private` **_goDormant**(): `void` - -#### Returns - -`void` - -#### Defined in - -[Ticker.ts:134](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L134) - -___ - -### \_tick - -▸ `Private` **_tick**(`iterationNumber`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iterationNumber` | `number` | - -#### Returns - -`void` - -#### Defined in - -[Ticker.ts:184](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L184) - -___ - ### offNextTick ▸ **offNextTick**(`fn`): `void` @@ -256,7 +119,7 @@ onNextTick #### Defined in -[Ticker.ts:114](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L114) +[Ticker.ts:114](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L114) ___ @@ -282,7 +145,7 @@ onThisOrNextTick #### Defined in -[Ticker.ts:103](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L103) +[Ticker.ts:103](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L103) ___ @@ -309,7 +172,7 @@ Registers a side effect to be called on the next tick. #### Defined in -[Ticker.ts:89](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L89) +[Ticker.ts:89](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L89) ___ @@ -342,7 +205,7 @@ offThisOrNextTick #### Defined in -[Ticker.ts:74](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L74) +[Ticker.ts:74](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L74) ___ @@ -369,4 +232,4 @@ Triggers a tick which starts executing the callbacks scheduled for this tick. #### Defined in -[Ticker.ts:149](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/Ticker.ts#L149) +[Ticker.ts:149](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/Ticker.ts#L149) diff --git a/packages/dataverse/api/interfaces/PointerToPrismProvider.md b/packages/dataverse/api/interfaces/PointerToPrismProvider.md index 525e7c4..7e18312 100644 --- a/packages/dataverse/api/interfaces/PointerToPrismProvider.md +++ b/packages/dataverse/api/interfaces/PointerToPrismProvider.md @@ -41,4 +41,4 @@ Returns a prism of the value at the provided pointer. #### Defined in -[pointerToPrism.ts:21](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/pointerToPrism.ts#L21) +[pointerToPrism.ts:21](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/pointerToPrism.ts#L21) diff --git a/packages/dataverse/api/interfaces/Prism-1.md b/packages/dataverse/api/interfaces/Prism-1.md index 514f76a..56a5ca1 100644 --- a/packages/dataverse/api/interfaces/Prism-1.md +++ b/packages/dataverse/api/interfaces/Prism-1.md @@ -34,7 +34,7 @@ Whether the prism is hot. #### Defined in -[prism/Interface.ts:18](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/Interface.ts#L18) +[prism/Interface.ts:18](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/Interface.ts#L18) ___ @@ -46,7 +46,7 @@ Whether the object is a prism. #### Defined in -[prism/Interface.ts:13](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/Interface.ts#L13) +[prism/Interface.ts:13](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/Interface.ts#L13) ## Methods @@ -62,7 +62,7 @@ Gets the current value of the prism. If the value is stale, it causes the prism #### Defined in -[prism/Interface.ts:60](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/Interface.ts#L60) +[prism/Interface.ts:60](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/Interface.ts#L60) ___ @@ -78,7 +78,7 @@ Keep the prism hot, even if there are no tappers (subscribers). #### Defined in -[prism/Interface.ts:34](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/Interface.ts#L34) +[prism/Interface.ts:34](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/Interface.ts#L34) ___ @@ -102,7 +102,7 @@ Calls `listener` with a fresh value every time the prism _has_ a new value, thro #### Defined in -[prism/Interface.ts:23](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/Interface.ts#L23) +[prism/Interface.ts:23](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/Interface.ts#L23) ___ @@ -122,4 +122,4 @@ ___ #### Defined in -[prism/Interface.ts:29](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/Interface.ts#L29) +[prism/Interface.ts:29](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/Interface.ts#L29) diff --git a/packages/dataverse/api/modules/prism.md b/packages/dataverse/api/modules/prism.md index 8dc9418..6caf9fe 100644 --- a/packages/dataverse/api/modules/prism.md +++ b/packages/dataverse/api/modules/prism.md @@ -49,7 +49,7 @@ An effect hook, similar to React's `useEffect()`, but is not sensitive to call o #### Defined in -[prism/prism.ts:885](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L885) +[prism/prism.ts:885](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L885) ___ @@ -88,7 +88,7 @@ setTimeout(() => { #### Defined in -[prism/prism.ts:887](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L887) +[prism/prism.ts:887](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L887) ___ @@ -108,7 +108,7 @@ true if the current function is running inside a `prism()` call. #### Defined in -[prism/prism.ts:891](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L891) +[prism/prism.ts:891](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L891) ___ @@ -154,7 +154,7 @@ const pr = prism(() => { #### Defined in -[prism/prism.ts:886](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L886) +[prism/prism.ts:886](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L886) ___ @@ -204,7 +204,7 @@ const pr = prism(() => { #### Defined in -[prism/prism.ts:884](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L884) +[prism/prism.ts:884](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L884) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -[prism/prism.ts:889](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L889) +[prism/prism.ts:889](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L889) ___ @@ -291,7 +291,7 @@ function prismFromInputElement(input: HTMLInputElement): Prism { #### Defined in -[prism/prism.ts:892](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L892) +[prism/prism.ts:892](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L892) ___ @@ -354,7 +354,7 @@ const mousePositionD = prism(() => { #### Defined in -[prism/prism.ts:888](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L888) +[prism/prism.ts:888](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L888) ___ @@ -392,4 +392,4 @@ The value of the inner prism #### Defined in -[prism/prism.ts:890](https://github.com/theatre-js/theatre/blob/327b859ed/packages/dataverse/src/prism/prism.ts#L890) +[prism/prism.ts:890](https://github.com/theatre-js/theatre/blob/main/packages/dataverse/src/prism/prism.ts#L890) diff --git a/packages/dataverse/typedoc.json b/packages/dataverse/typedoc.json new file mode 100644 index 0000000..a7e89a0 --- /dev/null +++ b/packages/dataverse/typedoc.json @@ -0,0 +1,23 @@ +{ + "visibilityFilters": { + "protected": false, + "private": false, + "inherited": true, + "external": false, + "@alpha": false, + "@beta": false + }, + "excludeTags": [ + "@override", + "@virtual", + "@privateRemarks", + "@satisfies", + "@overload", + "@remarks" + ], + "categorizeByGroup": false, + "excludeInternal": true, + "excludeProtected": true, + "excludePrivate": true, + "sourceLinkTemplate": "https://github.com/theatre-js/theatre/blob/main/{path}#L{line}" +}