Skip to content

Commit 9c8b865

Browse files
committed
patch
1 parent f13fda2 commit 9c8b865

45 files changed

Lines changed: 158 additions & 89 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/classes/ClientCompute.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ __@GET_COMPUTE_DATA_FN_SYMBOL@3164: any
4141
getComputeData(): Promise<any>;
4242
```
4343

44+
Retrieves the computed data.
45+
Returns the current result of the compute operation, either synchronously or asynchronously.
46+
4447
### calculate
4548

4649
```ts

docs/classes/ClientState.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ params: IStateParams<State>
3232
stateChanged: Subject<string>
3333
```
3434

35+
A subject that emits state names when changes occur, allowing subscribers to react to state updates.
36+
Provides reactive state change notifications throughout the system.
37+
3538
### _state
3639

3740
```ts

docs/classes/ComputeConnectionService.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ getComputeRef: ((clientId: string, computeName: string) => ClientCompute<any>) &
7575
getComputeData: () => Promise<any>
7676
```
7777

78+
Retrieves the computed data.
79+
Returns the current result of the compute operation, either synchronously or asynchronously.
80+
7881
### calculate
7982

8083
```ts

docs/classes/SharedComputeConnectionService.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ getComputeRef: ((computeName: string) => ClientCompute<any>) & IClearableMemoize
5757
getComputeData: () => Promise<any>
5858
```
5959

60+
Retrieves the computed data.
61+
Returns the current result of the compute operation, either synchronously or asynchronously.
62+
6063
### calculate
6164

6265
```ts

docs/interfaces/ICompute.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,6 @@ update: (clientId: string, computeName: string) => Promise<void>
2424
```ts
2525
getComputeData: () => T | Promise<T>
2626
```
27+
28+
Retrieves the computed data.
29+
Returns the current result of the compute operation, either synchronously or asynchronously.

docs/interfaces/IComputeCallbacks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,6 @@ onCalculate: (stateName: string, clientId: string, computeName: string) => void
3636
```ts
3737
onUpdate: (clientId: string, computeName: string) => void
3838
```
39+
40+
Called when the compute is updated.
41+
Triggered whenever compute data or configuration changes, allowing for reactive updates.

docs/interfaces/IComputeParams.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,6 @@ bus: IBus
3030
```ts
3131
binding: IStateChangeContract[]
3232
```
33+
34+
Array of state change contracts for state dependencies.
35+
Defines which state changes trigger compute recalculation and data updates.

docs/interfaces/IComputeSchema.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,6 @@ middlewares: IComputeMiddleware<T>[]
5454
```ts
5555
callbacks: Partial<IComputeCallbacks<T>>
5656
```
57+
58+
Optional callbacks for compute lifecycle events.
59+
Provides hooks for handling compute updates, data changes, and other lifecycle events.

docs/interfaces/IConfig.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,6 @@ The config for UML generation
1414
```ts
1515
withSubtree: boolean
1616
```
17+
18+
Whether to include subtree information in the UML diagram.
19+
Controls the level of detail and hierarchy shown in the generated visualization.

docs/interfaces/IFactoryParams$1.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

0 commit comments

Comments
 (0)