ow

object-walk

Walks through an object executing user defined functions at every node on the way down and back up.

Showing:

Popularity

Downloads/wk

299

GitHub Stars

6

Maintenance

Last Commit

8yrs ago

Contributors

0

Package

Dependencies

1

Size (min+gzip)

0.3KB

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

object-walk

Walks through an object executing user defined functions at every node on the way down and back up. Functions will be given three arguments: the value of the current node, the name of the current node, and the object being being walked through. This roughly resembles the callback signature of Array.prototype.map.

Installation

npm install object-walk

Usage

In node:

objectWalk = require('object-walk');
var obj = {
    child1 : {
        data : "some data"
    },
    child2 : {
        data : "some data"
    }
};
function descentionFn (val, prop, obj) {
    if (val === "some data") {
        obj[prop] = "changed";
    }
}
objectWalk(obj, descentionFn);
var obj = {
    child1 : {
        data : {
            child3 : {
                data : "some data"
            },
            child4 : {
                data : "some data"
            }
        }
    },
    child2 : {
        data : "some data"
    }
};
function ascentionFn (val, prop, obj) {
    if (prop === "data") {
        delete obj[prop].child3;
    }
    if (prop === "child4") {
        obj[prop].data = "changed";
    }
}
objectWalk(obj, null, ascentionFn);

In the browser, include ./browser/object-walk_web.js in your page. objectWalk will be available in your page.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial