github-pages-deploy-action/node_modules/is-plain-object/README.md

119 lines
4.1 KiB
Markdown
Raw Normal View History

2020-03-31 20:42:07 +08:00
# is-plain-object [![NPM version](https://img.shields.io/npm/v/is-plain-object.svg?style=flat)](https://www.npmjs.com/package/is-plain-object) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-plain-object.svg?style=flat)](https://npmjs.org/package/is-plain-object) [![NPM total downloads](https://img.shields.io/npm/dt/is-plain-object.svg?style=flat)](https://npmjs.org/package/is-plain-object) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-plain-object.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-plain-object)
> Returns true if an object was created by the `Object` constructor.
2020-06-06 22:11:37 +08:00
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
2020-03-31 20:42:07 +08:00
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save is-plain-object
```
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.
## Usage
```js
2020-06-06 22:11:37 +08:00
import isPlainObject from 'is-plain-object';
2020-03-31 20:42:07 +08:00
```
**true** when created by the `Object` constructor.
```js
isPlainObject(Object.create({}));
//=> true
isPlainObject(Object.create(Object.prototype));
//=> true
isPlainObject({foo: 'bar'});
//=> true
isPlainObject({});
//=> true
```
**false** when not created by the `Object` constructor.
```js
isPlainObject(1);
//=> false
isPlainObject(['foo', 'bar']);
//=> false
isPlainObject([]);
//=> false
isPlainObject(new Foo);
//=> false
isPlainObject(null);
//=> false
isPlainObject(Object.create(null));
//=> false
```
## About
2020-06-06 22:11:37 +08:00
<details>
<summary><strong>Contributing</strong></summary>
2020-03-31 20:42:07 +08:00
2020-06-06 22:11:37 +08:00
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
2020-03-31 20:42:07 +08:00
2020-06-06 22:11:37 +08:00
</details>
2020-03-31 20:42:07 +08:00
2020-06-06 22:11:37 +08:00
<details>
<summary><strong>Running Tests</strong></summary>
2020-03-31 20:42:07 +08:00
2020-06-06 22:11:37 +08:00
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
```
2020-03-31 20:42:07 +08:00
2020-06-06 22:11:37 +08:00
</details>
2020-03-31 20:42:07 +08:00
2020-06-06 22:11:37 +08:00
<details>
<summary><strong>Building docs</strong></summary>
2020-03-31 20:42:07 +08:00
_(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
```
2020-06-06 22:11:37 +08:00
</details>
2020-03-31 20:42:07 +08:00
2020-06-06 22:11:37 +08:00
### Related projects
2020-03-31 20:42:07 +08:00
2020-06-06 22:11:37 +08:00
You might also be interested in these projects:
* [is-number](https://www.npmjs.com/package/is-number): Returns true if a number or string value is a finite number. Useful for regex… [more](https://github.com/jonschlinkert/is-number) | [homepage](https://github.com/jonschlinkert/is-number "Returns true if a number or string value is a finite number. Useful for regex matches, parsing, user input, etc.")
* [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.")
* [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.")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 19 | [jonschlinkert](https://github.com/jonschlinkert) |
| 6 | [TrySound](https://github.com/TrySound) |
| 6 | [stevenvachon](https://github.com/stevenvachon) |
| 3 | [onokumus](https://github.com/onokumus) |
| 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |
2020-03-31 20:42:07 +08:00
### Author
**Jon Schlinkert**
2020-06-06 22:11:37 +08:00
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
2020-03-31 20:42:07 +08:00
### License
2020-06-06 22:11:37 +08:00
Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert).
2020-03-31 20:42:07 +08:00
Released under the [MIT License](LICENSE).
***
2020-06-06 22:11:37 +08:00
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 28, 2019._