@fav/prop.visit

Visits each properties in a plain object tree.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Jun 23, 2018Nov 30, 2017Minified + gzip package size for @fav/prop.visit in KB

Readme

@fav/prop.visit NPM MIT License Build Status Build Status Coverage status

Visits each properties in a plain object tree.

"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

Install

To install from npm:

$ npm install --save @fav/prop.visit

NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/prop.visit/ directory manually.

Usage

For Node.js:

var visit = require('@fav/prop.visit');
var logs = [];
visit({ a: 100, b: { c: 'C' } }, function(key, value, index, count, parentKeys, parentNode) {
  logs.push([key, value, index, count, parentKeys, parentNode]);
});
// => [
//  [ 'a', 100, 0, 2, [], { a: 100, b: { c: 'C' } } ],
//  [ 'b', { c: 'C' }, 1, 2, [], { a: 100, b: { c: 'C' } } ],
//  [ 'c', 'C', 0, 1, [ 'b' ], { c: 'C' } ] ]
// ]

For Web browsers:

<script src="fav.prop.visit.min.js"></script>
<script>
var visit = fav.prop.visit;
var logs = [];
visit({ a: 100, b: { c: 'C' } }, function(key, value, index, count, parentKeys, parentNode) {
  logs.push([key, value, index, count, parentKeys, parentNode]);
});
// => [
//  [ 'a', 100, 0, 2, [], { a: 100, b: { c: 'C' } } ],
//  [ 'b', { c: 'C' }, 1, 2, [], { a: 100, b: { c: 'C' } } ],
//  [ 'c', 'C', 0, 1, [ 'b' ], { c: 'C' } ] ]
// ]
</script>

API

visit(obj, fn) : Void

Visits each nodes in a plain object tree. This function deeply traces property nodes which are plain objects only, and apply a given function to enumerable and own properties (keys and symbols) of the traced property nodes.

Parameters:

Parameter Type Description
obj object A plain object to be traced its properties deeply.
fn function A function to be applied to visited properties.

The second argument function is passed following parameters, and the return value of this function controls if this function is applied to child and descendant properties of current property.

  • APIs of the second argument function

    Parameter:

    Parameter Type Description
    key string A key of current property.
    value any A value of current property.
    index number Index of current property among sibling properties.
    count number Count of sibling properties.
    parentKeys Array An array which contains keys of ancestor properties and represents a trace path to current property. Also, the length of this array suggests the depth of property tree.
    parentNode object A plain object which is a parent node.

    Returns:

    True, if stop digging child and descendant properties.

    Type: boolean

Checked

Node.js (4〜)

Platform 4 5 6 7 8 9 10
macOS
Windows10
Linux

io.js (1〜3)

Platform 1 2 3
macOS
Windows10
Linux

Node.js (〜0.12)

Platform 0.8 0.9 0.10 0.11 0.12
macOS
Windows10
Linux

Web browsers

Platform Chrome Firefox Vivaldi Safari Edge IE11
macOS -- --
Windows10 --
Linux -- -- --

License

Copyright (C) 2017-2018 Takayuki Sato

This program is free software under MIT License. See the file LICENSE in this distribution for more details.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.