Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fabioh8010 committed May 16, 2024
1 parent 3238b5d commit f59ea2e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions API-INTERNAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@ whatever it is we attempted to do.</p>
</dd>
<dt><a href="#removeNullValues">removeNullValues()</a> ⇒</dt>
<dd><p>Removes a key from storage if the value is null.
Otherwise removes all nested null values in objects and returns the object</p>
Otherwise removes all nested null values in objects,
if shouldRemoveNestedNulls is true and returns the object.</p>
</dd>
<dt><a href="#prepareKeyValuePairsForStorage">prepareKeyValuePairsForStorage()</a> ⇒</dt>
<dd><p>Storage expects array like: [[&quot;@MyApp_user&quot;, value_1], [&quot;@MyApp_key&quot;, value_2]]
Expand Down Expand Up @@ -367,7 +368,8 @@ Notifies subscribers and writes current value to cache

## removeNullValues() ⇒
Removes a key from storage if the value is null.
Otherwise removes all nested null values in objects and returns the object
Otherwise removes all nested null values in objects,
if shouldRemoveNestedNulls is true and returns the object.

**Kind**: global function
**Returns**: The value without null values and a boolean "wasRemoved", which indicates if the key got removed completely
Expand Down

0 comments on commit f59ea2e

Please sign in to comment.