gulpjs
each-props
Processes each properties of an object deeply.
Install
To install from npm:
$ npm i each-props --save
Usage
Apply a function to all (non plain object) properties.
const eachProps = require('each-props');
var obj = { a: 1, b: { c: 'CCC', d: { e: 'EEE' } } };
eachProps(obj, function (value, keyChain, nodeInfo) {
if (keyChain === 'a') {
nodeInfo.parent['a'] = value * 2;
} else if (keyChain === 'b.c') {
nodeInfo.parent['c'] = value.toLowerCase();
} else if (keyChain === 'b.d') {
return true; // stop to dig
} else if (keyChain === 'b.d.e') {
nodeInfo.parent['e'] = value.toLowerCase();
}
});
console.log(obj);
// => { a: 2, b: { c: 'ccc', d: { e: 'EEE' } } };
API
eachProps(obj, fn [, opts]) : void
Executes the fn function for all properties.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | object | A plain object to be treated. |
| fn | function | A function to operate each properties. |
| opts | object | An object to pass any data to each properties. |
API of fn function
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). |
Returns:
True, if stops digging child properties.
Type: boolean
Properties of nodeInfo
| Properties | Type | Description | | :--------- | :------: | :---------------------------------------------------------------------------------------------------------- | | name | string | The property name of this node. | | index | number | The index of the property among the sibling properties. | | count | number | The count of the sibling properties. | | depth | number | The depth of the property. | | parent | object | The parent node of the property. | | sort | function | A sort function which orders the child properties. This function is inherited from opts, if be specified. |
... and any properties inherited from opts.
Properties of opts
| Properties | Type | Description | | :--------- | :------: | :----------------------------------------------------------------- | | sort | function | A sort function which orders the same level properties. (Optional) |
... and any properties you want to pass to each node.
License
MIT