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.

84 lines
3.4 KiB

4 years ago
  1. # for-in [![NPM version](https://img.shields.io/npm/v/for-in.svg?style=flat)](https://www.npmjs.com/package/for-in) [![NPM monthly downloads](https://img.shields.io/npm/dm/for-in.svg?style=flat)](https://npmjs.org/package/for-in) [![NPM total downloads](https://img.shields.io/npm/dt/for-in.svg?style=flat)](https://npmjs.org/package/for-in) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/for-in.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/for-in)
  2. > Iterate over the own and inherited enumerable properties of an object, and return an object with properties that evaluate to true from the callback. Exit early by returning `false`. JavaScript/Node.js
  3. ## Install
  4. Install with [npm](https://www.npmjs.com/):
  5. ```sh
  6. $ npm install --save for-in
  7. ```
  8. ## Usage
  9. ```js
  10. var forIn = require('for-in');
  11. var obj = {a: 'foo', b: 'bar', c: 'baz'};
  12. var values = [];
  13. var keys = [];
  14. forIn(obj, function (value, key, o) {
  15. keys.push(key);
  16. values.push(value);
  17. });
  18. console.log(keys);
  19. //=> ['a', 'b', 'c'];
  20. console.log(values);
  21. //=> ['foo', 'bar', 'baz'];
  22. ```
  23. ## About
  24. ### Related projects
  25. * [arr-flatten](https://www.npmjs.com/package/arr-flatten): Recursively flatten an array or arrays. This is the fastest implementation of array flatten. | [homepage](https://github.com/jonschlinkert/arr-flatten "Recursively flatten an array or arrays. This is the fastest implementation of array flatten.")
  26. * [collection-map](https://www.npmjs.com/package/collection-map): Returns an array of mapped values from an array or object. | [homepage](https://github.com/jonschlinkert/collection-map "Returns an array of mapped values from an array or object.")
  27. * [for-own](https://www.npmjs.com/package/for-own): Iterate over the own enumerable properties of an object, and return an object with properties… [more](https://github.com/jonschlinkert/for-own) | [homepage](https://github.com/jonschlinkert/for-own "Iterate over the own enumerable properties of an object, and return an object with properties that evaluate to true from the callback. Exit early by returning `false`. JavaScript/Node.js.")
  28. ### Contributing
  29. Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  30. ### Contributors
  31. | **Commits** | **Contributor** |
  32. | --- | --- |
  33. | 16 | [jonschlinkert](https://github.com/jonschlinkert) |
  34. | 2 | [paulirish](https://github.com/paulirish) |
  35. ### Building docs
  36. _(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.)_
  37. To generate the readme, run the following command:
  38. ```sh
  39. $ npm install -g verbose/verb#dev verb-generate-readme && verb
  40. ```
  41. ### Running tests
  42. 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:
  43. ```sh
  44. $ npm install && npm test
  45. ```
  46. ### Author
  47. **Jon Schlinkert**
  48. * [github/jonschlinkert](https://github.com/jonschlinkert)
  49. * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
  50. ### License
  51. Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
  52. Released under the [MIT License](LICENSE).
  53. ***
  54. _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 28, 2017._