Add clearer behavior to readme (#84)

readmeio · Jun 20, 2023 · 73b3b64 · 73b3b64
1 parent 79e1e78
commit 73b3b64
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,3 +20,16 @@ import removeUndefinedObjects from 'remove-undefined-objects';
 console.log(removeUndefinedObjects({key: [], key2: 123}));
 // { key2: 123 }
 ```
+
+## Behavior
+
+Any items with the following value will be removed:
+
+* Empty object, `{}`
+* Empty array, `[]`
+* Undefined, `undefined`
+
+The following items will NOT be removed:
+
+* Empty string, `''`
+* Null, `null`