Skip to content

Commit

Permalink
chore(release): 2.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mrodrig committed Jun 1, 2021
1 parent efe1a24 commit aba2dbe
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 6 deletions.
42 changes: 38 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ included in the returned key path list?
```
- ignoreEmptyArraysWhenExpanding = `false` results in: `['features.name', 'rebates']`
- ignoreEmptyArraysWhenExpanding = `true` results in: `['features.name']`
- escapeNestedDots - `Boolean` (Default: `false`) - Should `.` characters that appear in keys be escaped with a preceding `\` character.
- escapeNestedDots - `Boolean` (Default: `false`) - Should `.` characters that appear in keys be escaped with a preceding `\` character?
- Example:
```json
{
Expand All @@ -102,6 +102,22 @@ included in the returned key path list?
```
- escapeNestedDots = `false` results in: `['a.a', 'a.b.c', 'a.b.c.d']`
- escapeNestedDots = `true` results in: `['a\\.a', 'a\\.b.c', 'a\\.b.c\\.d']`
- ignoreEmptyArrays - `Boolean` (Default: `false`) - Should key paths for empty arrays be ignored in the generated key list?
- Example:
```json
{
"a": {
"b": [],
"c": {
"f": 4,
"e": []
}
},
"b": []
}
```
- ignoreEmptyArrays = `false` results in `['a.b', 'a.c.f', 'a.c.e', 'b']`
- ignoreEmptyArrays = `true` results in `['a.c.f']`

Returns: `Array[String]`

Expand Down Expand Up @@ -159,6 +175,24 @@ included in the returned key path list?
```
- escapeNestedDots = `false` results in: `[ ['a.a', 'a.b.c', 'a.b.c.d'] ]`
- escapeNestedDots = `true` results in: `[ ['a\\.a', 'a\\.b.c', 'a\\.b.c\\.d'] ]`
- ignoreEmptyArrays - `Boolean` (Default: `false`) - Should key paths for empty arrays be ignored in the generated key list?
- Example:
```json
[
{
"a": {
"b": [],
"c": {
"f": 4,
"e": []
}
},
"b": []
}
]
```
- ignoreEmptyArrays = `false` results in `[ ['a.b', 'a.c.f', 'a.c.e', 'b'] ]`
- ignoreEmptyArrays = `true` results in `[ ['a.c.f'] ]`

Returns: `Array[Array[String]]`

Expand Down Expand Up @@ -211,8 +245,8 @@ $ npm run coverage

Current Coverage is:
```
Statements : 100% ( 45/45 )
Branches : 100% ( 32/32 )
Statements : 100% ( 47/47 )
Branches : 100% ( 37/37 )
Functions : 100% ( 18/18 )
Lines : 100% ( 44/44 )
Lines : 100% ( 46/46 )
```
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "deeks",
"version": "2.4.1",
"version": "2.5.0",
"description": "Retrieve all keys and nested keys from objects and arrays of objects.",
"main": "lib/deeks.js",
"scripts": {
Expand Down

0 comments on commit aba2dbe

Please sign in to comment.