Skip to content

Commit d65b1ec

Browse files
committed
Update docs
1 parent 74cea97 commit d65b1ec

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

API-INTERNAL.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@
2020
<dt><a href="#getEvictionBlocklist">getEvictionBlocklist()</a></dt>
2121
<dd><p>Getter - returns the eviction block list.</p>
2222
</dd>
23+
<dt><a href="#getSkippableCollectionMemberIDs">getSkippableCollectionMemberIDs()</a></dt>
24+
<dd><p>Getter - TODO</p>
25+
</dd>
26+
<dt><a href="#setSkippableCollectionMemberIDs">setSkippableCollectionMemberIDs()</a></dt>
27+
<dd><p>Setter - TODO</p>
28+
</dd>
2329
<dt><a href="#initStoreValues">initStoreValues(keys, initialKeyStates, safeEvictionKeys)</a></dt>
2430
<dd><p>Sets the initial values for the Onyx store</p>
2531
</dd>
@@ -53,7 +59,7 @@ The resulting collection will only contain items that are returned by the select
5359
<dd><p>Checks to see if the subscriber&#39;s supplied key
5460
is associated with a collection of keys.</p>
5561
</dd>
56-
<dt><a href="#splitCollectionMemberKey">splitCollectionMemberKey(key)</a> ⇒</dt>
62+
<dt><a href="#splitCollectionMemberKey">splitCollectionMemberKey(key, collectionKey)</a> ⇒</dt>
5763
<dd><p>Splits a collection member key into the collection key part and the ID part.</p>
5864
</dd>
5965
<dt><a href="#isKeyMatch">isKeyMatch()</a></dt>
@@ -187,6 +193,18 @@ Getter - returns the deffered init task.
187193
## getEvictionBlocklist()
188194
Getter - returns the eviction block list.
189195

196+
**Kind**: global function
197+
<a name="getSkippableCollectionMemberIDs"></a>
198+
199+
## getSkippableCollectionMemberIDs()
200+
Getter - TODO
201+
202+
**Kind**: global function
203+
<a name="setSkippableCollectionMemberIDs"></a>
204+
205+
## setSkippableCollectionMemberIDs()
206+
Setter - TODO
207+
190208
**Kind**: global function
191209
<a name="initStoreValues"></a>
192210

@@ -268,7 +286,7 @@ is associated with a collection of keys.
268286
**Kind**: global function
269287
<a name="splitCollectionMemberKey"></a>
270288

271-
## splitCollectionMemberKey(key) ⇒
289+
## splitCollectionMemberKey(key, collectionKey) ⇒
272290
Splits a collection member key into the collection key part and the ID part.
273291

274292
**Kind**: global function
@@ -278,6 +296,7 @@ or throws an Error if the key is not a collection one.
278296
| Param | Description |
279297
| --- | --- |
280298
| key | The collection member key to split. |
299+
| collectionKey | The collection key of the `key` param that can be passed in advance to optimize the function. |
281300

282301
<a name="isKeyMatch"></a>
283302

0 commit comments

Comments
 (0)