You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. # isobject [![NPM version](https://img.shields.io/npm/v/isobject.svg?style=flat)](https://www.npmjs.com/package/isobject) [![NPM monthly downloads](https://img.shields.io/npm/dm/isobject.svg?style=flat)](https://npmjs.org/package/isobject) [![NPM total downloads](https://img.shields.io/npm/dt/isobject.svg?style=flat)](https://npmjs.org/package/isobject) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/isobject.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/isobject)
  2. > Returns true if the value is an object and not an array or null.
  3. ## Install
  4. Install with [npm](https://www.npmjs.com/):
  5. ```sh
  6. $ npm install --save isobject
  7. ```
  8. Install with [yarn](https://yarnpkg.com):
  9. ```sh
  10. $ yarn add isobject
  11. ```
  12. Use [is-plain-object](https://github.com/jonschlinkert/is-plain-object) if you want only objects that are created by the `Object` constructor.
  13. ## Install
  14. Install with [npm](https://www.npmjs.com/):
  15. ```sh
  16. $ npm install isobject
  17. ```
  18. Install with [bower](https://bower.io/)
  19. ```sh
  20. $ bower install isobject
  21. ```
  22. ## Usage
  23. ```js
  24. var isObject = require('isobject');
  25. ```
  26. **True**
  27. All of the following return `true`:
  28. ```js
  29. isObject({});
  30. isObject(Object.create({}));
  31. isObject(Object.create(Object.prototype));
  32. isObject(Object.create(null));
  33. isObject({});
  34. isObject(new Foo);
  35. isObject(/foo/);
  36. ```
  37. **False**
  38. All of the following return `false`:
  39. ```js
  40. isObject();
  41. isObject(function () {});
  42. isObject(1);
  43. isObject([]);
  44. isObject(undefined);
  45. isObject(null);
  46. ```
  47. ## About
  48. ### Related projects
  49. * [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow "Extend an object with the properties of additional objects. node.js/javascript util.")
  50. * [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object "Returns true if an object was created by the `Object` constructor.")
  51. * [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.")
  52. * [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep "Recursively merge values in a javascript object.")
  53. ### Contributing
  54. Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  55. ### Contributors
  56. | **Commits** | **Contributor** |
  57. | --- | --- |
  58. | 29 | [jonschlinkert](https://github.com/jonschlinkert) |
  59. | 4 | [doowb](https://github.com/doowb) |
  60. | 1 | [magnudae](https://github.com/magnudae) |
  61. | 1 | [LeSuisse](https://github.com/LeSuisse) |
  62. | 1 | [tmcw](https://github.com/tmcw) |
  63. ### Building docs
  64. _(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.)_
  65. To generate the readme, run the following command:
  66. ```sh
  67. $ npm install -g verbose/verb#dev verb-generate-readme && verb
  68. ```
  69. ### Running tests
  70. 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:
  71. ```sh
  72. $ npm install && npm test
  73. ```
  74. ### Author
  75. **Jon Schlinkert**
  76. * [github/jonschlinkert](https://github.com/jonschlinkert)
  77. * [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
  78. ### License
  79. Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
  80. Released under the [MIT License](LICENSE).
  81. ***
  82. _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 30, 2017._