Skip to content

Commit 084f594

Browse files
author
sttk
committed
1.2.0
1 parent 01acf7c commit 084f594

4 files changed

Lines changed: 177 additions & 150 deletions

File tree

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
33

44
Process object properties deeply.
55

6-
[repo-url]: https://github.com/sttk/each-props/
7-
[npm-img]: https://img.shields.io/badge/npm-v1.1.0-blue.svg
8-
[npm-url]: https://www.npmjs.org/package/each-props/
9-
[mit-img]: https://img.shields.io/badge/license-MIT-green.svg
10-
[mit-url]: https://opensource.org/licenses.MIT
11-
[travis-img]: https://travis-ci.org/sttk/each-props.svg?branch=master
12-
[travis-url]: https://travis-ci.org/sttk/each-props
13-
[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/sttk/each-props?branch=master&svg=true
14-
[appveyor-url]: https://ci.appveyor.com/project/sttk/each-props
15-
[coverage-img]: https://coveralls.io/repos/github/sttk/each-props/badge.svg?branch=master
16-
[coverage-url]: https://coveralls.io/github/sttk/each-props?branch=master
17-
186
Install
197
-------
208

@@ -71,18 +59,20 @@ Executes the *callback* function for all properties.
7159
* **Arguments :**
7260
* **value** [any] : The property value.
7361
* **keyChain** [string] : A string concatenating the hierarchical keys with dots.
74-
* **nodeInfo** [object] : An object which contains properties: `index`, `count`, `depth`, `parent`, `sort`, and can contains more properties by specifying in `opts` above.
62+
* **nodeInfo** [object] : An object which contains properties: `name`, `index`, `count`, `depth`, `parent`, `sort`, and can contains more properties by specifying in `opts` above.
7563

7664
* **Returns :** [boolean] : Stops digging child properties if `true`.
7765

78-
##### **Properties of *nodeInfo* :**
66+
##### **Properties of *nodeInfo* :**
7967

80-
* ***nodeInfo*** *[object]*
81-
* **index** [number] : The index of the property among the sibling properties.
82-
* **count** [number] : The count of the sibling properties.
83-
* **depth** [number] : The depth in the property hierarchy.
84-
* **parent** [object] : The parent property.
85-
* **sort** [function] : A sort function which orders the child properties. This property is inherited from **opts**, if specified.
68+
* ***nodeInfo*** *[object]*
69+
* **name** [string] : The property name of this node.
70+
* **index** [number] : The index of the property among the sibling properties.
71+
* **count** [number] : The count of the sibling properties.
72+
* **depth** [number] : The depth in the property hierarchy.
73+
* **parent** [object] : The parent property.
74+
* **sort** [function] : A sort function which orders the child properties. This property is inherited from **opts**, if specified.
75+
* ... and any properties inherited from **opts**.
8676

8777
##### **Properties of *opts* :**
8878

@@ -97,3 +87,16 @@ Copyright (C) 2016 Takayuki Sato
9787

9888
This program is free software under [MIT][mit-url] License.
9989
See the file LICENSE in this distribution for more details.
90+
91+
[repo-url]: https://github.com/sttk/each-props/
92+
[npm-img]: https://img.shields.io/badge/npm-v1.2.0-blue.svg
93+
[npm-url]: https://www.npmjs.org/package/each-props/
94+
[mit-img]: https://img.shields.io/badge/license-MIT-green.svg
95+
[mit-url]: https://opensource.org/licenses.MIT
96+
[travis-img]: https://travis-ci.org/sttk/each-props.svg?branch=master
97+
[travis-url]: https://travis-ci.org/sttk/each-props
98+
[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/sttk/each-props?branch=master&svg=true
99+
[appveyor-url]: https://ci.appveyor.com/project/sttk/each-props
100+
[coverage-img]: https://coveralls.io/repos/github/sttk/each-props/badge.svg?branch=master
101+
[coverage-url]: https://coveralls.io/github/sttk/each-props?branch=master
102+

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "each-props",
3-
"version": "1.1.0",
3+
"version": "1.2.0",
44
"description": "Process each properties deeply.",
55
"main": "index.js",
66
"files": [

0 commit comments

Comments
 (0)