node_modules/is-plain-object/README.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

is-plain-object

Returns true if an object was created by the Object constructor.

Install

Install with npm:

$ npm install --save is-plain-object

Use isobject if you only want to check if the value is an object and not an array or null.

Usage

var isPlainObject = require('is-plain-object');

true when created by the Object constructor.

isPlainObject(Object.create({}));
//=> true
isPlainObject(Object.create(Object.prototype));
//=> true
isPlainObject({foo: 'bar'});
//=> true
isPlainObject({});
//=> true

false when not created by the Object constructor.

isPlainObject(1);
//=> false
isPlainObject(['foo', 'bar']);
//=> false
isPlainObject([]);
//=> false
isPlainObject(new Foo);
//=> false
isPlainObject(null);
//=> false
isPlainObject(Object.create(null));
//=> false

About

Related projects

• is-number: Returns true if the value is a number. comprehensive tests. | homepage
• isobject: Returns true if the value is an object and not an array or null. | homepage
• kind-of: Get the native type of a value. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

| Commits | Contributor | | --- | --- | | 17 | jonschlinkert | | 6 | stevenvachon | | 3 | onokumus | | 1 | wtgtybhertgeghgtwtg |

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on July 11, 2017.

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.