From f38a02bec9ed69be71a237fa87c8554a22df5568 Mon Sep 17 00:00:00 2001 From: Blaine Bublitz Date: Sun, 2 Oct 2022 10:57:21 -0700 Subject: [PATCH] chore: Cleanup readme --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ac2e529..b1869f9 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ console.log(obj); ## API -### eachProps(obj, fn [, opts]) : void +### eachProps(obj, fn [, opts]) : void Executes the _fn_ function for all properties. @@ -59,17 +59,17 @@ Executes the _fn_ function for all properties. - **API of _fn_ function** - #### fn(value, keyChain, nodeInfo) : boolean + #### 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: @@ -77,9 +77,7 @@ Executes the _fn_ function for all properties. **Type:** boolean - - -- **Properties of nodeInfo** +- ##### **Properties of _nodeInfo_** | Properties | Type | Description | | :--------- | :------: | :---------------------------------------------------------------------------------------------------------- | @@ -92,7 +90,7 @@ Executes the _fn_ function for all properties. ... and any properties inherited from _opts_. -- **Properties of opts** +- ##### **Properties of _opts_** | Properties | Type | Description | | :--------- | :------: | :----------------------------------------------------------------- | @@ -117,5 +115,5 @@ MIT -[mit-url]: https://opensource.org/licenses/MIT +[nodeinfo]: #properties-of-nodeinfo