You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

88 lines
3.4 KiB

4 years ago
  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. > Visit a method over the items in an object, or map visit over the objects in an array.
  3. ## Install
  4. Install with [npm](https://www.npmjs.com/):
  5. ```sh
  6. $ npm install --save collection-visit
  7. ```
  8. ## Usage
  9. ```js
  10. var visit = require('collection-visit');
  11. var ctx = {
  12. data: {},
  13. set: function (key, value) {
  14. if (typeof key === 'object') {
  15. visit(ctx, 'set', key);
  16. } else {
  17. ctx.data[key] = value;
  18. }
  19. }
  20. };
  21. ctx.set('a', 'a');
  22. ctx.set('b', 'b');
  23. ctx.set('c', 'c');
  24. ctx.set({d: {e: 'f'}});
  25. console.log(ctx.data);
  26. //=> {a: 'a', b: 'b', c: 'c', d: { e: 'f' }};
  27. ```
  28. ## About
  29. ### Related projects
  30. * [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`.")
  31. * [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.")
  32. * [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.")
  33. ### Contributing
  34. Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  35. ### Contributors
  36. | **Commits** | **Contributor** |
  37. | --- | --- |
  38. | 13 | [jonschlinkert](https://github.com/jonschlinkert) |
  39. | 9 | [doowb](https://github.com/doowb) |
  40. ### Building docs
  41. _(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.)_
  42. To generate the readme, run the following command:
  43. ```sh
  44. $ npm install -g verbose/verb#dev verb-generate-readme && verb
  45. ```
  46. ### Running tests
  47. 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:
  48. ```sh
  49. $ npm install && npm test
  50. ```
  51. ### Author
  52. **Jon Schlinkert**
  53. * [github/jonschlinkert](https://github.com/jonschlinkert)
  54. * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
  55. ### License
  56. Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
  57. Released under the [MIT License](LICENSE).
  58. ***
  59. _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 09, 2017._