Blame view

node_modules/for-in/README.md 3.37 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
  # 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)
  
  > 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
  
  ## Install
  
  Install with [npm](https://www.npmjs.com/):
  
  ```sh
  $ npm install --save for-in
  ```
  
  ## Usage
  
  ```js
  var forIn = require('for-in');
  
  var obj = {a: 'foo', b: 'bar', c: 'baz'};
  var values = [];
  var keys = [];
  
  forIn(obj, function (value, key, o) {
    keys.push(key);
    values.push(value);
  });
  
  console.log(keys);
  //=> ['a', 'b', 'c'];
  
  console.log(values);
  //=> ['foo', 'bar', 'baz'];
  ```
  
  ## About
  
  ### Related projects
  
  * [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.")
  * [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.")
  * [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.")
  
  ### Contributing
  
  Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  
  ### Contributors
  
  | **Commits** | **Contributor** | 
  | --- | --- |
  | 16 | [jonschlinkert](https://github.com/jonschlinkert) |
  | 2 | [paulirish](https://github.com/paulirish) |
  
  ### 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.4.2, on February 28, 2017._