maraj 1.0.6 → 1.0.8

package/README.md

@@ -2,8 +2,11 @@
 # Maraj
 
 A lightweight alternative for creating **immutable updates of objects and arrays.**
+
 **4 times faster** than the commonly used alternatives like Immer or ImmutableJS.
+
 Only **600 bytes** gziped with 5 common utilities that you will most likelly need in every project.
+
 Features:
 - Can accept multiple updates while mantaining the order of execution.
 - Easy syntax for conditional updates.
@@ -19,7 +22,7 @@ The **updateObject** has the following syntax:
 
 It can accept multiple key-value pairs and the order of execution will be preserved.
 
-- **Key:** path name of the fiels, separated by commas (same syntax you use to access object properties)
+- **Key:** path name of the fiels, separated by commas (same syntax you use to access object/array properties)
     - For arrays just use its index value
     - Can accept conditional statements. (If the key is falsy, undefined or null it will not update the new value into the new object.)
 
@@ -47,7 +50,7 @@ const person = {
             description: 'lorem ipsum',
             available: false,
             data:{
-                createdAt: '01-01-2000'
+                createdAt: '01-01-2000',
                 size: 20000
             }
         },
@@ -57,7 +60,7 @@ const person = {
             description: 'lorem ipsum',
             available: true,
             data:{
-                createdAt: '01-01-2000'
+                createdAt: '01-01-2000',
                 size: 40000
             }
         },
@@ -67,7 +70,7 @@ const person = {
             description: 'lorem ipsum',
             available: false,
             data:{
-                createdAt: '01-01-2000'
+                createdAt: '01-01-2000',
                 size: 100000
             }
         }
@@ -75,11 +78,11 @@ const person = {
 }
 
 const newUpdatedObject = createImmutableUpdate(person,{
-    'name': Maraj //normal update
-    'projects.0.title': 'personal website' //nested update
-    'projects.1.available': true //nested update
-    'projects.1.available': (currentValue) => !currentValue //functional update
-    'projects': (currentValue) => currentValue.filter(project => project.available) //functional update
+    'name': 'maraj', //normal update
+    'projects.0.title': 'website', //nested update
+    'projects.1.available': true, //nested update
+    'projects.1.available': (currentValue) => !currentValue, //functional update
+    'projects': (currentValue) => currentValue.filter(project => project.available), //functional update
     [condition && 'additionalInfo.info1']: 'some info' //conditional update, only if the key is not false/undefined/null
 })
 ```
@@ -89,33 +92,37 @@ const newUpdatedObject = createImmutableUpdate(person,{
 ### spread
 
 Spreads its argument into the key provided in the **createImmutableUpdate.**
-Works with objects(updates its keys) and arrays(adds new values to the array)
+
+Works with **objects (updates its keys)**, **arrays (adds new values to the array)** and **any other value (sets the new value)**
 
 ```js
 import {spread} from 'maraj'
 
 const newUpdatedObject = createImmutableUpdate(person,{
-    'additionalInfo.info1': spread({info1: 'new Info'}) //same as (newValue) => (value) => ({...value, ...newValue})
+    'additionalInfo': spread({info1: 'new Info'}), //same as (newValue) => (value) => ({...value, ...newValue})
     'projects': spread({title: 'new project'}) //same as (newValueToAdd) => (value) => ([...value, ...newValueToAdd])
+    'additionalInfo.info1': spread('new project') //same as (newValue) => (value) => (newValue)
 })
 ```
 
 ### remove
 
-Removes the key of an object or the index of an array in the key provided in the **createImmutableUpdate.**
+Removes the **key of an object** or the **index of an array** in the key provided in the **createImmutableUpdate.**
 
 ```js
 import {remove} from 'maraj'
 
 const newUpdatedObject = createImmutableUpdate(person,{
-    'additionalInfo': remove('info1') // returns new value (in this case "additionalInfo") without the provided key ("info1")
+    'additionalInfo': remove('info1'), // returns new value (in this case "additionalInfo") without the provided key ("info1")
     'projects': remove(1) // returns new array (in this case "projects") without the provided index (1)
 })
 ```
 
 ### createSelectorFromStringPath
 
-Creates a store selector from provided string path. Usefull in cases like getting data from Redux, Zustand, and so on. stores.
+**Creates a store selector** from provided string path.
+
+Usefull in cases like getting data from Redux, Zustand, and so on. stores.
 
 ```js
 import {createSelectorFromStringPath} from 'maraj'
@@ -131,4 +138,15 @@ Usefull when you want to spread multiple values into objects dynamically
 
 Splits string path (example:'projects.1.data.size' ) into two:
 - id: the last key in the path (in this case 'size')
-- remainingPath: the remaining path (in this case 'projects.1.data')
+- remainingPath: the remaining path (in this case 'projects.1.data')
+
+
+```js
+import {splitPath} from 'maraj'
+
+const stringPath = 'projects.1.data.size'
+
+const { id, remainingPath } = splitPath(stringPath)
+// id = 'size'
+// remainingPath = 'projects.1.data'
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "maraj",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "A lightweight 600 bytes gzipped alternative for immutable updates while dealing with objects and arrays",
   "main": "index.js",
   "scripts": {