Skip to content

Commit 73b3b64

Browse files
authored
Add clearer behavior to readme (#84)
1 parent 79e1e78 commit 73b3b64

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,16 @@ import removeUndefinedObjects from 'remove-undefined-objects';
2020
console.log(removeUndefinedObjects({key: [], key2: 123}));
2121
// { key2: 123 }
2222
```
23+
24+
## Behavior
25+
26+
Any items with the following value will be removed:
27+
28+
* Empty object, `{}`
29+
* Empty array, `[]`
30+
* Undefined, `undefined`
31+
32+
The following items will NOT be removed:
33+
34+
* Empty string, `''`
35+
* Null, `null`

0 commit comments

Comments
 (0)