Skip to content

Commit f38a02b

Browse files
committed
chore: Cleanup readme
1 parent 3f75efd commit f38a02b

1 file changed

Lines changed: 10 additions & 12 deletions

File tree

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ console.log(obj);
4545

4646
## API
4747

48-
### <u>eachProps(obj, fn [, opts]) : void</u>
48+
### eachProps(obj, fn [, opts]) : void
4949

5050
Executes the _fn_ function for all properties.
5151

@@ -59,27 +59,25 @@ Executes the _fn_ function for all properties.
5959

6060
- **API of _fn_ function**
6161

62-
#### <u>fn(value, keyChain, nodeInfo) : boolean</u>
62+
#### fn(value, keyChain, nodeInfo) : boolean
6363

6464
This function is applied to all properties in an object.
6565

6666
##### Parameters:
6767

68-
| Parameter | Type | Description |
69-
| :--------- | :----: | :------------------------------------------------------------------- |
70-
| _value_ | any | A property value. |
71-
| _keyChain_ | string | A string concatenating the hierarchical keys with dots. |
72-
| _nodeInfo_ | object | An object which contains node informations (See [below](#nodeinfo)). |
68+
| Parameter | Type | Description |
69+
| :--------- | :----: | :------------------------------------------------------------------ |
70+
| _value_ | any | A property value. |
71+
| _keyChain_ | string | A string concatenating the hierarchical keys with dots. |
72+
| _nodeInfo_ | object | An object which contains node informations (See [below][nodeinfo]). |
7373

7474
##### Returns:
7575

7676
True, if stops digging child properties.
7777

7878
**Type:** boolean
7979

80-
<a name="nodeinfo"></a>
81-
82-
- **Properties of <i>nodeInfo</i>**
80+
- ##### **Properties of _nodeInfo_**
8381

8482
| Properties | Type | Description |
8583
| :--------- | :------: | :---------------------------------------------------------------------------------------------------------- |
@@ -92,7 +90,7 @@ Executes the _fn_ function for all properties.
9290

9391
... and any properties inherited from _opts_.
9492

95-
- **Properties of <i>opts</i>**
93+
- ##### **Properties of _opts_**
9694

9795
| Properties | Type | Description |
9896
| :--------- | :------: | :----------------------------------------------------------------- |
@@ -117,5 +115,5 @@ MIT
117115
<!-- prettier-ignore-end -->
118116

119117
<!-- prettier-ignore-start -->
120-
[mit-url]: https://opensource.org/licenses/MIT
118+
[nodeinfo]: #properties-of-nodeinfo
121119
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)