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.

82 lines
3.5 KiB

4 years ago
  1. # object-visit [![NPM version](https://img.shields.io/npm/v/object-visit.svg?style=flat)](https://www.npmjs.com/package/object-visit) [![NPM monthly downloads](https://img.shields.io/npm/dm/object-visit.svg?style=flat)](https://npmjs.org/package/object-visit) [![NPM total downloads](https://img.shields.io/npm/dt/object-visit.svg?style=flat)](https://npmjs.org/package/object-visit) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/object-visit.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/object-visit)
  2. > Call a specified method on each value in the given object.
  3. ## Install
  4. Install with [npm](https://www.npmjs.com/):
  5. ```sh
  6. $ npm install --save object-visit
  7. ```
  8. ## Usage
  9. ```js
  10. var visit = require('object-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. * [collection-visit](https://www.npmjs.com/package/collection-visit): Visit a method over the items in an object, or map visit over the objects… [more](https://github.com/jonschlinkert/collection-visit) | [homepage](https://github.com/jonschlinkert/collection-visit "Visit a method over the items in an object, or map visit over the objects in an array.")
  32. * [define-property](https://www.npmjs.com/package/define-property): Define a non-enumerable property on an object. | [homepage](https://github.com/jonschlinkert/define-property "Define a non-enumerable property on an object.")
  33. * [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.")
  34. ### Contributing
  35. Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  36. ### Building docs
  37. _(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.)_
  38. To generate the readme, run the following command:
  39. ```sh
  40. $ npm install -g verbose/verb#dev verb-generate-readme && verb
  41. ```
  42. ### Running tests
  43. 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:
  44. ```sh
  45. $ npm install && npm test
  46. ```
  47. ### Author
  48. **Jon Schlinkert**
  49. * [github/jonschlinkert](https://github.com/jonschlinkert)
  50. * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
  51. ### License
  52. Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
  53. Released under the [MIT License](LICENSE).
  54. ***
  55. _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 30, 2017._