readmongo/node_modules/is-accessor-descriptor

is-accessor-descriptor

Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save is-accessor-descriptor

Usage

var isAccessor = require('is-accessor-descriptor');

isAccessor({get: function() {}});
//=> true

You may also pass an object and property name to check if the property is an accessor:

isAccessor(foo, 'bar');

Examples

false when not an object

isAccessor('a')
isAccessor(null)
isAccessor([])
//=> false

true when the object has valid properties

and the properties all have the correct JavaScript types:

isAccessor({get: noop, set: noop})
isAccessor({get: noop})
isAccessor({set: noop})
//=> true

false when the object has invalid properties

isAccessor({get: noop, set: noop, bar: 'baz'})
isAccessor({get: noop, writable: true})
isAccessor({get: noop, value: true})
//=> false

false when an accessor is not a function

isAccessor({get: noop, set: 'baz'})
isAccessor({get: 'foo', set: noop})
isAccessor({get: 'foo', bar: 'baz'})
isAccessor({get: 'foo', set: 'baz'})
//=> false

false when a value is not the correct type

isAccessor({get: noop, set: noop, enumerable: 'foo'})
isAccessor({set: noop, configurable: 'foo'})
isAccessor({get: noop, configurable: 'foo'})
//=> false

About

Contributing

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

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

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

Related projects

You might also be interested in these projects:

• is-accessor-descriptor: Returns true if a value has the characteristics of a valid JavaScript accessor descriptor. | homepage
• is-data-descriptor: Returns true if a value has the characteristics of a valid JavaScript data descriptor. | homepage
• is-descriptor: Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… more | homepage
• is-plain-object: Returns true if an object was created by the Object constructor. | homepage
• isobject: Returns true if the value is an object and not an array or null. | homepage

Contributors

Commits	Contributor
22	jonschlinkert
2	realityking

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 November 01, 2017.