1 | # collection-visit [![NPM version](https://img.shields.io/npm/v/collection-visit.svg?style=flat)](https://www.npmjs.com/package/collection-visit) [![NPM monthly downloads](https://img.shields.io/npm/dm/collection-visit.svg?style=flat)](https://npmjs.org/package/collection-visit) [![NPM total downloads](https://img.shields.io/npm/dt/collection-visit.svg?style=flat)](https://npmjs.org/package/collection-visit) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/collection-visit.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/collection-visit)
|
---|
2 |
|
---|
3 | > Visit a method over the items in an object, or map visit over the objects in an array.
|
---|
4 |
|
---|
5 | ## Install
|
---|
6 |
|
---|
7 | Install with [npm](https://www.npmjs.com/):
|
---|
8 |
|
---|
9 | ```sh
|
---|
10 | $ npm install --save collection-visit
|
---|
11 | ```
|
---|
12 |
|
---|
13 | ## Usage
|
---|
14 |
|
---|
15 | ```js
|
---|
16 | var visit = require('collection-visit');
|
---|
17 |
|
---|
18 | var ctx = {
|
---|
19 | data: {},
|
---|
20 | set: function (key, value) {
|
---|
21 | if (typeof key === 'object') {
|
---|
22 | visit(ctx, 'set', key);
|
---|
23 | } else {
|
---|
24 | ctx.data[key] = value;
|
---|
25 | }
|
---|
26 | }
|
---|
27 | };
|
---|
28 |
|
---|
29 | ctx.set('a', 'a');
|
---|
30 | ctx.set('b', 'b');
|
---|
31 | ctx.set('c', 'c');
|
---|
32 | ctx.set({d: {e: 'f'}});
|
---|
33 |
|
---|
34 | console.log(ctx.data);
|
---|
35 | //=> {a: 'a', b: 'b', c: 'c', d: { e: 'f' }};
|
---|
36 | ```
|
---|
37 |
|
---|
38 | ## About
|
---|
39 |
|
---|
40 | ### Related projects
|
---|
41 |
|
---|
42 | * [base-methods](https://www.npmjs.com/package/base-methods): base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://github.com/jonschlinkert/base-methods) | [homepage](https://github.com/jonschlinkert/base-methods "base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like `set`, `get`, `del` and `use`.")
|
---|
43 | * [map-visit](https://www.npmjs.com/package/map-visit): Map `visit` over an array of objects. | [homepage](https://github.com/jonschlinkert/map-visit "Map `visit` over an array of objects.")
|
---|
44 | * [object-visit](https://www.npmjs.com/package/object-visit): Call a specified method on each value in the given object. | [homepage](https://github.com/jonschlinkert/object-visit "Call a specified method on each value in the given object.")
|
---|
45 |
|
---|
46 | ### Contributing
|
---|
47 |
|
---|
48 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
---|
49 |
|
---|
50 | ### Contributors
|
---|
51 |
|
---|
52 | | **Commits** | **Contributor** |
|
---|
53 | | --- | --- |
|
---|
54 | | 13 | [jonschlinkert](https://github.com/jonschlinkert) |
|
---|
55 | | 9 | [doowb](https://github.com/doowb) |
|
---|
56 |
|
---|
57 | ### Building docs
|
---|
58 |
|
---|
59 | _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
|
---|
60 |
|
---|
61 | To generate the readme, run the following command:
|
---|
62 |
|
---|
63 | ```sh
|
---|
64 | $ npm install -g verbose/verb#dev verb-generate-readme && verb
|
---|
65 | ```
|
---|
66 |
|
---|
67 | ### Running tests
|
---|
68 |
|
---|
69 | 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:
|
---|
70 |
|
---|
71 | ```sh
|
---|
72 | $ npm install && npm test
|
---|
73 | ```
|
---|
74 |
|
---|
75 | ### Author
|
---|
76 |
|
---|
77 | **Jon Schlinkert**
|
---|
78 |
|
---|
79 | * [github/jonschlinkert](https://github.com/jonschlinkert)
|
---|
80 | * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
|
---|
81 |
|
---|
82 | ### License
|
---|
83 |
|
---|
84 | Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
|
---|
85 | Released under the [MIT License](LICENSE).
|
---|
86 |
|
---|
87 | ***
|
---|
88 |
|
---|
89 | _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 09, 2017._ |
---|