| 1 | # is-plain-object [](https://www.npmjs.com/package/is-plain-object) [](https://npmjs.org/package/is-plain-object) [](https://npmjs.org/package/is-plain-object) [](https://travis-ci.org/jonschlinkert/is-plain-object)
|
|---|
| 2 |
|
|---|
| 3 | > Returns true if an object was created by the `Object` constructor.
|
|---|
| 4 |
|
|---|
| 5 | ## Install
|
|---|
| 6 |
|
|---|
| 7 | Install with [npm](https://www.npmjs.com/):
|
|---|
| 8 |
|
|---|
| 9 | ```sh
|
|---|
| 10 | $ npm install --save is-plain-object
|
|---|
| 11 | ```
|
|---|
| 12 |
|
|---|
| 13 | Use [isobject](https://github.com/jonschlinkert/isobject) if you only want to check if the value is an object and not an array or null.
|
|---|
| 14 |
|
|---|
| 15 | ## Usage
|
|---|
| 16 |
|
|---|
| 17 | ```js
|
|---|
| 18 | var isPlainObject = require('is-plain-object');
|
|---|
| 19 | ```
|
|---|
| 20 |
|
|---|
| 21 | **true** when created by the `Object` constructor.
|
|---|
| 22 |
|
|---|
| 23 | ```js
|
|---|
| 24 | isPlainObject(Object.create({}));
|
|---|
| 25 | //=> true
|
|---|
| 26 | isPlainObject(Object.create(Object.prototype));
|
|---|
| 27 | //=> true
|
|---|
| 28 | isPlainObject({foo: 'bar'});
|
|---|
| 29 | //=> true
|
|---|
| 30 | isPlainObject({});
|
|---|
| 31 | //=> true
|
|---|
| 32 | ```
|
|---|
| 33 |
|
|---|
| 34 | **false** when not created by the `Object` constructor.
|
|---|
| 35 |
|
|---|
| 36 | ```js
|
|---|
| 37 | isPlainObject(1);
|
|---|
| 38 | //=> false
|
|---|
| 39 | isPlainObject(['foo', 'bar']);
|
|---|
| 40 | //=> false
|
|---|
| 41 | isPlainObject([]);
|
|---|
| 42 | //=> false
|
|---|
| 43 | isPlainObject(new Foo);
|
|---|
| 44 | //=> false
|
|---|
| 45 | isPlainObject(null);
|
|---|
| 46 | //=> false
|
|---|
| 47 | isPlainObject(Object.create(null));
|
|---|
| 48 | //=> false
|
|---|
| 49 | ```
|
|---|
| 50 |
|
|---|
| 51 | ## About
|
|---|
| 52 |
|
|---|
| 53 | ### Related projects
|
|---|
| 54 |
|
|---|
| 55 | * [is-number](https://www.npmjs.com/package/is-number): Returns true if the value is a number. comprehensive tests. | [homepage](https://github.com/jonschlinkert/is-number "Returns true if the value is a number. comprehensive tests.")
|
|---|
| 56 | * [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject "Returns true if the value is an object and not an array or null.")
|
|---|
| 57 | * [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of "Get the native type of a value.")
|
|---|
| 58 |
|
|---|
| 59 | ### Contributing
|
|---|
| 60 |
|
|---|
| 61 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
|---|
| 62 |
|
|---|
| 63 | ### Contributors
|
|---|
| 64 |
|
|---|
| 65 | | **Commits** | **Contributor** |
|
|---|
| 66 | | --- | --- |
|
|---|
| 67 | | 17 | [jonschlinkert](https://github.com/jonschlinkert) |
|
|---|
| 68 | | 6 | [stevenvachon](https://github.com/stevenvachon) |
|
|---|
| 69 | | 3 | [onokumus](https://github.com/onokumus) |
|
|---|
| 70 | | 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |
|
|---|
| 71 |
|
|---|
| 72 | ### Building docs
|
|---|
| 73 |
|
|---|
| 74 | _(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.)_
|
|---|
| 75 |
|
|---|
| 76 | To generate the readme, run the following command:
|
|---|
| 77 |
|
|---|
| 78 | ```sh
|
|---|
| 79 | $ npm install -g verbose/verb#dev verb-generate-readme && verb
|
|---|
| 80 | ```
|
|---|
| 81 |
|
|---|
| 82 | ### Running tests
|
|---|
| 83 |
|
|---|
| 84 | 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:
|
|---|
| 85 |
|
|---|
| 86 | ```sh
|
|---|
| 87 | $ npm install && npm test
|
|---|
| 88 | ```
|
|---|
| 89 |
|
|---|
| 90 | ### Author
|
|---|
| 91 |
|
|---|
| 92 | **Jon Schlinkert**
|
|---|
| 93 |
|
|---|
| 94 | * [github/jonschlinkert](https://github.com/jonschlinkert)
|
|---|
| 95 | * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
|
|---|
| 96 |
|
|---|
| 97 | ### License
|
|---|
| 98 |
|
|---|
| 99 | Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
|
|---|
| 100 | Released under the [MIT License](LICENSE).
|
|---|
| 101 |
|
|---|
| 102 | ***
|
|---|
| 103 |
|
|---|
| 104 | _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 11, 2017._ |
|---|
