89 lines
3.4 KiB
Markdown
89 lines
3.4 KiB
Markdown
# collection-visit [](https://www.npmjs.com/package/collection-visit) [](https://npmjs.org/package/collection-visit) [](https://npmjs.org/package/collection-visit) [](https://travis-ci.org/jonschlinkert/collection-visit)
|
|
|
|
> Visit a method over the items in an object, or map visit over the objects in an array.
|
|
|
|
## Install
|
|
|
|
Install with [npm](https://www.npmjs.com/):
|
|
|
|
```sh
|
|
$ npm install --save collection-visit
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
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](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`.")
|
|
* [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.")
|
|
* [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.")
|
|
|
|
### Contributing
|
|
|
|
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
|
|
|
### Contributors
|
|
|
|
| **Commits** | **Contributor** |
|
|
| --- | --- |
|
|
| 13 | [jonschlinkert](https://github.com/jonschlinkert) |
|
|
| 9 | [doowb](https://github.com/doowb) |
|
|
|
|
### Building docs
|
|
|
|
_(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.)_
|
|
|
|
To generate the readme, run the following command:
|
|
|
|
```sh
|
|
$ 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:
|
|
|
|
```sh
|
|
$ npm install && npm test
|
|
```
|
|
|
|
### Author
|
|
|
|
**Jon Schlinkert**
|
|
|
|
* [github/jonschlinkert](https://github.com/jonschlinkert)
|
|
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
|
|
|
|
### License
|
|
|
|
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
|
|
Released under the [MIT License](LICENSE).
|
|
|
|
***
|
|
|
|
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 09, 2017._ |