Skip to content

Commit

Permalink
chore: Cleanup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Oct 2, 2022
1 parent 3f75efd commit f38a02b
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Expand Up @@ -45,7 +45,7 @@ console.log(obj);

## API

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

Executes the _fn_ function for all properties.

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

- **API of _fn_ function**

#### <u>fn(value, keyChain, nodeInfo) : boolean</u>
#### fn(value, keyChain, nodeInfo) : boolean

This function is applied to all properties in an object.

##### Parameters:

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

##### Returns:

True, if stops digging child properties.

**Type:** boolean

<a name="nodeinfo"></a>

- **Properties of <i>nodeInfo</i>**
- ##### **Properties of _nodeInfo_**

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

... and any properties inherited from _opts_.

- **Properties of <i>opts</i>**
- ##### **Properties of _opts_**

| Properties | Type | Description |
| :--------- | :------: | :----------------------------------------------------------------- |
Expand All @@ -117,5 +115,5 @@ MIT
<!-- prettier-ignore-end -->

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

0 comments on commit f38a02b

Please sign in to comment.