www.aleph1.co.uk Git - yaffs-website/blob - node_modules/for-own/README.md

   1 # for-own [![NPM version](https://img.shields.io/npm/v/for-own.svg?style=flat)](https://www.npmjs.com/package/for-own) [![NPM monthly downloads](https://img.shields.io/npm/dm/for-own.svg?style=flat)](https://npmjs.org/package/for-own)  [![NPM total downloads](https://img.shields.io/npm/dt/for-own.svg?style=flat)](https://npmjs.org/package/for-own) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/for-own.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/for-own)
   2
   3 > 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.
   4
   5 ## Install
   6
   7 Install with [npm](https://www.npmjs.com/):
   8
   9 ```sh
  10 $ npm install --save for-own
  11 ```
  12
  13 ## Usage
  14
  15 ```js
  16 var forOwn = require('for-own');
  17
  18 var obj = {a: 'foo', b: 'bar', c: 'baz'};
  19 var values = [];
  20 var keys = [];
  21
  22 forOwn(obj, function (value, key, o) {
  23   keys.push(key);
  24   values.push(value);
  25 });
  26
  27 console.log(keys);
  28 //=> ['a', 'b', 'c'];
  29
  30 console.log(values);
  31 //=> ['foo', 'bar', 'baz'];
  32 ```
  33
  34 ## About
  35
  36 ### Related projects
  37
  38 * [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.")
  39 * [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.")
  40 * [for-in](https://www.npmjs.com/package/for-in): Iterate over the own and inherited enumerable properties of an object, and return an object… [more](https://github.com/jonschlinkert/for-in) | [homepage](https://github.com/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")
  41
  42 ### Contributing
  43
  44 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  45
  46 ### Contributors
  47
  48 | **Commits** | **Contributor** |
  49 | --- | --- |
  50 | 10 | [jonschlinkert](https://github.com/jonschlinkert) |
  51 | 1 | [javiercejudo](https://github.com/javiercejudo) |
  52
  53 ### Building docs
  54
  55 _(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.)_
  56
  57 To generate the readme, run the following command:
  58
  59 ```sh
  60 $ npm install -g verbose/verb#dev verb-generate-readme && verb
  61 ```
  62
  63 ### Running tests
  64
  65 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:
  66
  67 ```sh
  68 $ npm install && npm test
  69 ```
  70
  71 ### Author
  72
  73 **Jon Schlinkert**
  74
  75 * [github/jonschlinkert](https://github.com/jonschlinkert)
  76 * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
  77
  78 ### License
  79
  80 Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
  81 Released under the [MIT License](LICENSE).
  82
  83 ***
  84
  85 _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 26, 2017._