Module core/storage/utils

Index

Functions

Functions

deleteKeyFromNestedObject

deleteKeyFromNestedObject(obj: JSONObject, index: StorageIndex): JSONObject

- Defined in src/core/storage/utils.ts:101
Deletes an entry in a given object on a given index.

No-op in case the index is not found.

throws
In case the index is invalid i.e. doesn't contain an entry or doesn't exist.

Parameters
- obj: JSONObject
  
  The object to update
- index: StorageIndex
  
  The index of the entry to delete
Returns JSONObject
An updated copy of the object.

getValueFromNestedObject

getValueFromNestedObject(obj: JSONObject, index: StorageIndex): JSONValue | undefined

- Defined in src/core/storage/utils.ts:17
Gets an entry in a given object on a given index.

throws
In case the index is an empty array.

Parameters
- obj: JSONObject
  
  The object to update
- index: StorageIndex
  
  The index of the entry to update
Returns JSONValue | undefined
The value of the entry if any was found and undefined otherwise.

updateNestedObject

updateNestedObject(obj: JSONObject, index: StorageIndex, transformFn: (v?: JSONValue) => JSONValue): JSONObject

- Defined in src/core/storage/utils.ts:54
Updates / Adds an entry in a given object on a given index.

Important

Any errors thrown on a transformation function are bubbled up.

Remember to take in to account that storage may not contain the data we expect it to, so always validate the type of the value passed on to the transformation function.

Parameters
- obj: JSONObject
  
  The object to update
- index: StorageIndex
  
  The index of the entry to update
- transformFn: (v?: JSONValue) => JSONValue
  
  A transformation function to apply to the currently persisted value.
  - - (v?: JSONValue): JSONValue
    - Parameters
      - Optional v: JSONValue
      Returns JSONValue
Returns JSONObject
An updated copy of the object.

Generated using TypeDoc