Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fabioh8010 committed Dec 14, 2024
1 parent 74cea97 commit d65b1ec
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions API-INTERNAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
<dt><a href="#getEvictionBlocklist">getEvictionBlocklist()</a></dt>
<dd><p>Getter - returns the eviction block list.</p>
</dd>
<dt><a href="#getSkippableCollectionMemberIDs">getSkippableCollectionMemberIDs()</a></dt>
<dd><p>Getter - TODO</p>
</dd>
<dt><a href="#setSkippableCollectionMemberIDs">setSkippableCollectionMemberIDs()</a></dt>
<dd><p>Setter - TODO</p>
</dd>
<dt><a href="#initStoreValues">initStoreValues(keys, initialKeyStates, safeEvictionKeys)</a></dt>
<dd><p>Sets the initial values for the Onyx store</p>
</dd>
Expand Down Expand Up @@ -53,7 +59,7 @@ The resulting collection will only contain items that are returned by the select
<dd><p>Checks to see if the subscriber&#39;s supplied key
is associated with a collection of keys.</p>
</dd>
<dt><a href="#splitCollectionMemberKey">splitCollectionMemberKey(key)</a> ⇒</dt>
<dt><a href="#splitCollectionMemberKey">splitCollectionMemberKey(key, collectionKey)</a> ⇒</dt>
<dd><p>Splits a collection member key into the collection key part and the ID part.</p>
</dd>
<dt><a href="#isKeyMatch">isKeyMatch()</a></dt>
Expand Down Expand Up @@ -187,6 +193,18 @@ Getter - returns the deffered init task.
## getEvictionBlocklist()
Getter - returns the eviction block list.

**Kind**: global function
<a name="getSkippableCollectionMemberIDs"></a>

## getSkippableCollectionMemberIDs()
Getter - TODO

**Kind**: global function
<a name="setSkippableCollectionMemberIDs"></a>

## setSkippableCollectionMemberIDs()
Setter - TODO

**Kind**: global function
<a name="initStoreValues"></a>

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

## splitCollectionMemberKey(key) ⇒
## splitCollectionMemberKey(key, collectionKey) ⇒
Splits a collection member key into the collection key part and the ID part.

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

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

Expand Down

0 comments on commit d65b1ec

Please sign in to comment.