Package Exports

is-accessor-descriptor
is-accessor-descriptor/package.json

Readme

is-accessor-descriptor

<<<<<<< .merge_file_oXHkzP

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

Install
Usage
Examples
API
Related projects
Running tests
Contributing
Author
License

Install

Install with npm:

$ npm i is-accessor-descriptor --save

.merge_file_OTGJy6

<<<<<<< .merge_file_oXHkzP

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

Examples

const isAccessorDescriptor = require('is-accessor-descriptor');
const assert = require('assert');

const obj = {
    get foo() {},
    bar: { get: function() {} }
};

assert.equal(true, isAccessorDescriptor(obj, 'foo'));
assert.equal(false, isAccessorDescriptor(obj, 'bar'));

// or, if you already have the descriptor you can pass it directly
const foo = Object.getOwnPropertyDescriptor(obj, 'foo');
assert.equal(true, isAccessorDescriptor(foo));

const bar = Object.getOwnPropertyDescriptor(obj, 'bar');
assert.equal(false, isAccessorDescriptor(bar));

You might also be interested in these projects:

is-data-descriptor: Returns true if a value has the characteristics of a valid JavaScript data descriptor.
is-descriptor: Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… more
is-object: Returns true if the value is an object and not an array or null.

Tests

Simply clone the repo, npm install, and run npm test

=======

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

assert.equal(isAccessor({ get() {} }), true);

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

assert.equal(isAccessor({ bar: 'foo' }, 'bar'), false);

Examples

false when not an object

assert.equal(isAccessor('a'), false);
assert.equal(isAccessor(null), false);

true when the object has valid properties

and the properties all have the correct JavaScript types:

assert.equal(isAccessor({ get() {}, set() {} }), true);
assert.equal(isAccessor({ get() {} }), true);
assert.equal(isAccessor({ set() {} }), true);

false when the object has invalid properties

assert.equal(isAccessor({ get() {}, set() {}, enumerable: 'baz' }), false);
assert.equal(isAccessor({ get() {}, writable: true }), false);
assert.equal(isAccessor({ get() {}, value: true }), false);
//=> false

false when an accessor is not a function

assert.equal(isAccessor({ get() {}, set: 'baz' }), false);
assert.equal(isAccessor({ get: 'foo', set() {} }), false);
assert.equal(isAccessor({ get: 'foo', bar: 'baz' }), false);
assert.equal(isAccessor({ get: 'foo', set: 'baz' }), false);
//=> false

false when a value is not the correct type

assert.equal(isAccessor({ get() {}, set() {}, enumerable: 'foo' }), false);
assert.equal(isAccessor({ set() {}, configurable: 'foo' }), false);
assert.equal(isAccessor({ get() {}, configurable: 'foo' }), false);
//=> false

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

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

.merge_file_OTGJy6