collection-visit

What is collection-visit?

The collection-visit npm package is designed to provide a simple way to visit and apply functions to elements in an object or array. It allows developers to easily manipulate and handle collections of data by iterating over them and invoking a specified method on each element of the collection.

What are collection-visit's main functionalities?

Visiting objects

This feature allows you to visit a specific path within an object and perform operations on it. In the code sample, the `visit` function is used to log the value at the path 'a.b' within the object.

const visit = require('collection-visit');
const obj = { a: { b: { c: 'd' } } };
visit(obj, 'a.b', console.log);  // logs { c: 'd' }

Visiting arrays

This feature enables visiting elements within an array and applying a function to each element. The code sample demonstrates visiting each object in the array and logging the 'name' property.

const visit = require('collection-visit');
const arr = [{ name: 'Alice' }, { name: 'Bob' }];
visit(arr, 'name', console.log);  // logs 'Alice' and 'Bob'

Other packages similar to collection-visit

lodash

Lodash is a comprehensive toolkit similar to collection-visit but with a broader range of utilities for working with arrays, numbers, objects, strings, etc. It includes functions like _.get and _.set for deep property access similar to what collection-visit offers but with additional capabilities like deep cloning, merging, and more.

object-visit

Object-visit is similar to collection-visit but is specifically tailored for objects. It allows you to visit and update values at specified paths within an object. It's more specialized compared to collection-visit which handles both arrays and objects.

README

collection-visit

Visit a method over the items in an object, or map visit over the objects in an array.

Install

Install with npm:

$ npm install --save collection-visit

Usage

var visit = require('collection-visit');

var ctx = {
  data: {},
  set: function (key, value) {
    if (typeof key === 'object') {
      visit(ctx, 'set', key);
    } else {
      ctx.data[key] = value;
    }
  }
};

ctx.set('a', 'a');
ctx.set('b', 'b');
ctx.set('c', 'c');
ctx.set({d: {e: 'f'}});

console.log(ctx.data);
//=> {a: 'a', b: 'b', c: 'c', d: { e: 'f' }};

About

Related projects

• base-methods: base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
• map-visit: Map visit over an array of objects. | homepage
• object-visit: Call a specified method on each value in the given object. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
13	jonschlinkert
9	doowb

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.5.0, on April 09, 2017.