@@ -48,7 +48,9 @@ class Controller {
4848}
4949```
5050
51- ## fetch(endpoint, ...args) {#fetch}
51+ ## Action Dispatchers
52+
53+ ### fetch(endpoint, ...args) {#fetch}
5254
5355Fetches the endpoint with given args, updating the Reactive Data Client cache with
5456the response or error upon completion.
@@ -143,22 +145,22 @@ post.pk();
143145
144146:::
145147
146- ### Endpoint.sideEffect
148+ #### Endpoint.sideEffect
147149
148150[ sideEffect] ( /rest/api/Endpoint#sideeffect ) changes the behavior
149151
150- #### true
152+ ##### true
151153
152154- Resolves _ before_ [ committing] ( https://react.dev/learn/render-and-commit#step-3-react-commits-changes-to-the-dom ) Reactive Data Client cache updates.
153155- Each call will always cause a new fetch.
154156
155- #### undefined
157+ ##### undefined
156158
157159- Resolves _ after_ [ committing] ( https://react.dev/learn/render-and-commit#step-3-react-commits-changes-to-the-dom ) Reactive Data Client cache updates.
158160- Identical requests are deduplicated globally; allowing only one inflight request at a time.
159161 - To ensure a _ new_ request is started, make sure to abort any existing inflight requests.
160162
161- ## fetchIfStale(endpoint, ...args) {#fetchIfStale}
163+ ### fetchIfStale(endpoint, ...args) {#fetchIfStale}
162164
163165Fetches only if endpoint is considered '[ stale] ( ../concepts/expiry-policy.md#stale ) '.
164166
@@ -190,7 +192,7 @@ An [example](https://stackblitz.com/github/reactive/data-client/tree/master/exam
190192
191193<StackBlitz app =" github-app " file =" src/routing/routes.tsx " view =" editor " />
192194
193- ## expireAll(\{ testKey }) {#expireAll}
195+ ### expireAll(\{ testKey }) {#expireAll}
194196
195197Sets all responses' [ expiry status] ( ../concepts/expiry-policy.md ) matching ` testKey ` to [ Stale] ( ../concepts/expiry-policy.md#stale ) .
196198
@@ -228,7 +230,7 @@ better to [include mutation sideeffects in the mutation response](/rest/guides/s
228230
229231:::
230232
231- ## invalidate(endpoint, ...args) {#invalidate}
233+ ### invalidate(endpoint, ...args) {#invalidate}
232234
233235Forces refetching and suspense on [ useSuspense] ( ./useSuspense.md ) with the same Endpoint
234236and parameters.
@@ -268,7 +270,7 @@ controller.setResponse(MyResource.delete, { id: '5' }, { id: '5' });
268270
269271:::
270272
271- ## invalidateAll(\{ testKey } ) { #invalidateAll }
273+ ### invalidateAll(\{ testKey } ) { #invalidateAll }
272274
273275[Invalidates](../concepts/expiry-policy#invalid) all [endpoint keys](/rest/api/RestEndpoint#key) matching `testKey`.
274276
@@ -333,7 +335,7 @@ ReactDOM.createRoot(document.body).render(
333335);
334336```
335337
336- ## resetEntireStore() { #resetEntireStore }
338+ ### resetEntireStore() { #resetEntireStore }
337339
338340Resets/clears the entire Reactive Data Client cache. All inflight requests will not resolve.
339341
@@ -361,7 +363,7 @@ function UserName() {
361363}
362364```
363365
364- ## set(queryable, ...args, value) { #set }
366+ ### set(queryable, ...args, value) { #set }
365367
366368Updates any [Queryable](/rest/api/schema#queryable) [Schema](/rest/api/schema#schema-overview).
367369
@@ -380,7 +382,7 @@ const id = '2';
380382ctrl.set(Article, { id } , article => ({ id , votes : article .votes + 1 } ));
381383```
382384
383- ## setResponse(endpoint, ...args, response) { #setResponse }
385+ ### setResponse(endpoint, ...args, response) { #setResponse }
384386
385387Stores `response` in cache for given [Endpoint](/rest/api/Endpoint) and args.
386388
@@ -408,11 +410,11 @@ useEffect(() => {
408410This shows a proof of concept in React; however a [Manager websockets implementation](../concepts/managers.md#data-stream)
409411would be much more robust.
410412
411- ## setError(endpoint, ...args, error) { #setError }
413+ ### setError(endpoint, ...args, error) { #setError }
412414
413415Stores the result of [Endpoint](/rest/api/Endpoint) and args as the error provided.
414416
415- ## resolve(endpoint, \{ args , response , fetchedAt , error } ) { #resolve }
417+ ### resolve(endpoint, \{ args , response , fetchedAt , error } ) { #resolve }
416418
417419Resolves a specific fetch, storing the `response` in cache.
418420
@@ -422,7 +424,7 @@ This means the corresponding optimistic update will no longer be applies.
422424This is used in [NetworkManager](./NetworkManager.md), and should be used when
423425processing fetch requests.
424426
425- ## subscribe(endpoint, ...args) { #subscribe }
427+ ### subscribe(endpoint, ...args) { #subscribe }
426428
427429Marks a new subscription to a given [Endpoint](/rest/api/Endpoint). This should increment the subscription.
428430
@@ -440,18 +442,20 @@ useEffect(() => {
440442} , [controller, key]);
441443```
442444
443- ## unsubscribe(endpoint, ...args) { #unsubscribe }
445+ ### unsubscribe(endpoint, ...args) { #unsubscribe }
444446
445447Marks completion of subscription to a given [Endpoint](/rest/api/Endpoint). This should
446448decrement the subscription and if the count reaches 0, more updates won't be received automatically.
447449
448450[useSubscription](./useSubscription.md) and [useLive](./useLive.md) call this on unmount.
449451
450- ## get(schema, ...args, state) { #get }
452+ ## Data Access
453+
454+ ### get(schema, ...args, state) { #get }
451455
452456Looks up any [Queryable](/rest/api/schema#queryable) [Schema](/rest/api/schema#schema-overview) in `state`.
453457
454- ### Example
458+ #### Example
455459
456460This is used in [useQuery](./useQuery.md) and can be used in
457461[Managers](./Manager.md) to safely access the store.
@@ -477,7 +481,7 @@ function useQuery<S extends Queryable>(
477481}
478482```
479483
480- ## getResponse(endpoint, ...args, state) { #getResponse }
484+ ### getResponse(endpoint, ...args, state) { #getResponse }
481485
482486```ts title="returns"
483487{
@@ -489,11 +493,11 @@ function useQuery<S extends Queryable>(
489493
490494Gets the (globally referentially stable) response for a given endpoint/args pair from state given.
491495
492- ### data
496+ #### data
493497
494498The denormalize response data. Guarantees global referential stability for all members.
495499
496- ### expiryStatus
500+ #### expiryStatus
497501
498502```ts
499503export enum ExpiryStatus {
@@ -503,26 +507,26 @@ export enum ExpiryStatus {
503507}
504508```
505509
506- #### Valid
510+ ##### Valid
507511
508512- Will never suspend.
509513- Might fetch if data is stale
510514
511- #### InvalidIfStale
515+ ##### InvalidIfStale
512516
513517- Will suspend if data is stale.
514518- Might fetch if data is stale
515519
516- #### Invalid
520+ ##### Invalid
517521
518522- Will always suspend
519523- Will always fetch
520524
521- ### expiresAt
525+ #### expiresAt
522526
523527A number representing time when it expires. Compare to Date.now().
524528
525- ### Example
529+ #### Example
526530
527531This is used in [useCache](./useCache.md), [useSuspense](./useSuspense.md) and can be used in
528532[Managers](./Manager.md) to lookup a response with the state provided.
@@ -572,15 +576,15 @@ export default class MyManager implements Manager {
572576}
573577```
574578
575- ## getError(endpoint, ...args, state) { #getError }
579+ ### getError(endpoint, ...args, state) { #getError }
576580
577581Gets the error, if any, for a given endpoint. Returns undefined for no errors.
578582
579- ## snapshot(state, fetchedAt) { #snapshot }
583+ ### snapshot(state, fetchedAt) { #snapshot }
580584
581585Returns a [Snapshot](./Snapshot.md).
582586
583- ## getState() { #getState }
587+ ### getState() { #getState }
584588
585589Gets the internal state of Reactive Data Client that has _already been [committed](https://react.dev/learn/render-and-commit#step-3-react-commits-changes-to-the-dom)_.
586590
0 commit comments