@fav/type.is-plain-object

Checks whether a value is a plain object or not.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00May 13, 2018Oct 8, 2017Minified + gzip package size for @fav/type.is-plain-object in KB

Readme

@fav/type.is-plain-object NPM MIT License Build Status Build Status Coverage status

Checks whether a value is a plain object or not.

"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

Install

To install from npm:

$ npm install --save @fav/type.is-plain-object

NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/type.is-plain-object/ directory manually.

Usage

For Node.js:

var isPlainObject = require('@fav/type.is-plain-object');
isPlainObject({ a: 1 }); // => true
isPlainObject.not({ a: 1 }); // => false

For Web browsers:

<script src="fav.type.is-plain-object.min.js"></script>
<script>
var isPlainObject = fav.type.isPlainObject;
isPlainObject({ a: 1 }); // => true
isPlainObject.not({ a: 1 }); // => false
</script>

API

isPlainObject(value) : boolean

Checks if value is a plain object.

Parameter:

Parameter Type Description
value any The value to be checked.

Return:

True, if value is a plain object.

Type: boolean

isPlainObject.not(value) : boolean

Checks if value is not a plain object.

This function always returns a negative boolean of isPlainObject(value).

Parameter:

Parameter Type Description
value any The value to be checked.

Return:

True, if value is not a plain object.

Type: boolean

Checked

Node.js (4〜)

Platform 4 5 6 7 8 9 10
macOS
Windows10
Linux

io.js (1〜3)

Platform 1 2 3
macOS
Windows10
Linux

Node.js (〜0.12)

Platform 0.8 0.9 0.10 0.11 0.12
macOS
Windows10
Linux

Web browsers

Platform Chrome Firefox Vivaldi Safari Edge IE11
macOS -- --
Windows10 --
Linux -- -- --

License

Copyright (C) 2017-2018 Takayuki Sato

This program is free software under MIT License. See the file LICENSE in this distribution for more details.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.