Skip to content

Commit de62ae5

Browse files
elirangoshenclaude
andcommitted
Regenerate API-INTERNAL.md for new write helpers
`npm run build:docs` output for the three new file-private helpers introduced in the previous commit: persistMultiSetWrite, persistCollectionWrite, persistMergedCollectionWrite. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent bfd6902 commit de62ae5

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

API-INTERNAL.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,17 +125,33 @@ It will also mark deep nested objects that need to be entirely replaced during t
125125
Serves as core implementation for <code>Onyx.set()</code> public function, the difference being
126126
that this internal function allows passing an additional <code>retryAttempt</code> parameter to retry on failure.</p>
127127
</dd>
128+
<dt><a href="#persistMultiSetWrite">persistMultiSetWrite()</a></dt>
129+
<dd><p>Storage-write tail of multiSetWithRetry, isolated so that retryOperation re-enters only the
130+
storage step. Cache and subscriber notifications already happened in the orchestrator, so
131+
retries no longer re-fire <code>waitForCollectionCallback</code> subscribers with the same payload.</p>
132+
</dd>
128133
<dt><a href="#multiSetWithRetry">multiSetWithRetry(data, retryAttempt)</a></dt>
129134
<dd><p>Sets multiple keys and values.
130135
Serves as core implementation for <code>Onyx.multiSet()</code> public function, the difference being
131136
that this internal function allows passing an additional <code>retryAttempt</code> parameter to retry on failure.</p>
132137
</dd>
138+
<dt><a href="#persistCollectionWrite">persistCollectionWrite()</a></dt>
139+
<dd><p>Storage-write tail of setCollectionWithRetry, isolated so that retryOperation re-enters only the
140+
storage step. Cache and subscriber notifications already happened in the orchestrator, so
141+
retries no longer re-fire <code>waitForCollectionCallback</code> subscribers with the same payload.</p>
142+
</dd>
133143
<dt><a href="#setCollectionWithRetry">setCollectionWithRetry(params, retryAttempt)</a></dt>
134144
<dd><p>Sets a collection by replacing all existing collection members with new values.
135145
Any existing collection members not included in the new data will be removed.
136146
Serves as core implementation for <code>Onyx.setCollection()</code> public function, the difference being
137147
that this internal function allows passing an additional <code>retryAttempt</code> parameter to retry on failure.</p>
138148
</dd>
149+
<dt><a href="#persistMergedCollectionWrite">persistMergedCollectionWrite()</a></dt>
150+
<dd><p>Storage-write tail of mergeCollectionWithPatches, isolated so that retryOperation re-enters only
151+
the storage step. Cache and subscriber notifications already happened in the orchestrator, and
152+
the existing/new key split is captured in <code>params</code> — so retries don&#39;t re-fire subscribers and
153+
don&#39;t reclassify keys against a cache that was already mutated on the first attempt.</p>
154+
</dd>
139155
<dt><a href="#mergeCollectionWithPatches">mergeCollectionWithPatches(params, retryAttempt)</a></dt>
140156
<dd><p>Merges a collection based on their keys.
141157
Serves as core implementation for <code>Onyx.mergeCollection()</code> public function, the difference being
@@ -435,6 +451,14 @@ that this internal function allows passing an additional `retryAttempt` paramete
435451
| params.options | optional configuration object |
436452
| retryAttempt | retry attempt |
437453

454+
<a name="persistMultiSetWrite"></a>
455+
456+
## persistMultiSetWrite()
457+
Storage-write tail of multiSetWithRetry, isolated so that retryOperation re-enters only the
458+
storage step. Cache and subscriber notifications already happened in the orchestrator, so
459+
retries no longer re-fire `waitForCollectionCallback` subscribers with the same payload.
460+
461+
**Kind**: global function
438462
<a name="multiSetWithRetry"></a>
439463

440464
## multiSetWithRetry(data, retryAttempt)
@@ -449,6 +473,14 @@ that this internal function allows passing an additional `retryAttempt` paramete
449473
| data | object keyed by ONYXKEYS and the values to set |
450474
| retryAttempt | retry attempt |
451475

476+
<a name="persistCollectionWrite"></a>
477+
478+
## persistCollectionWrite()
479+
Storage-write tail of setCollectionWithRetry, isolated so that retryOperation re-enters only the
480+
storage step. Cache and subscriber notifications already happened in the orchestrator, so
481+
retries no longer re-fire `waitForCollectionCallback` subscribers with the same payload.
482+
483+
**Kind**: global function
452484
<a name="setCollectionWithRetry"></a>
453485

454486
## setCollectionWithRetry(params, retryAttempt)
@@ -466,6 +498,15 @@ that this internal function allows passing an additional `retryAttempt` paramete
466498
| params.collection | Object collection keyed by individual collection member keys and values |
467499
| retryAttempt | retry attempt |
468500

501+
<a name="persistMergedCollectionWrite"></a>
502+
503+
## persistMergedCollectionWrite()
504+
Storage-write tail of mergeCollectionWithPatches, isolated so that retryOperation re-enters only
505+
the storage step. Cache and subscriber notifications already happened in the orchestrator, and
506+
the existing/new key split is captured in `params` — so retries don't re-fire subscribers and
507+
don't reclassify keys against a cache that was already mutated on the first attempt.
508+
509+
**Kind**: global function
469510
<a name="mergeCollectionWithPatches"></a>
470511

471512
## mergeCollectionWithPatches(params, retryAttempt)

0 commit comments

Comments
 (0)