is-descriptor

Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for fully completed data descriptors and accessor descriptors.

Usage

1const isDescriptor = require('is-descriptor');
2const assert = require('assert');
3
4const defaults = { configurable: false, enumerable: false };
5const dataDefaults = { ...defaults, writable: false};
6
7assert.ok(isDescriptor({ ...dataDefaults, value: 'foo' }));
8assert.ok(isDescriptor({ ...defaults, get() {}, set() {} }));
9assert.ok(!isDescriptor({ ...defaults, get: 'foo', set() {} }));

You may also check for a descriptor by passing an object as the first argument and property name (string) as the second argument.

1const obj = { foo: 'abc' };
2
3Object.defineProperty(obj, 'bar', { value: 'xyz' });
4Reflect.defineProperty(obj, 'baz', { value: 'xyz' });
5
6assert.equal(isDescriptor(obj, 'foo'), true);
7assert.equal(isDescriptor(obj, 'bar'), true);
8assert.equal(isDescriptor(obj, 'baz'), true);

Examples

value type

Returns false when not an object

1assert.equal(isDescriptor('a'), false);
2assert.equal(isDescriptor(null), false);
3assert.equal(isDescriptor([]), false);

data descriptor

Returns true when the object has valid properties with valid values.

1assert.equal(isDescriptor({ ...dataDefaults, value: 'foo' }), true);
2assert.equal(isDescriptor({ ...dataDefaults, value() {} }), true);

Returns false when the object has invalid properties

1assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', bar: 'baz' }), false);
2assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', bar: 'baz' }), false);
3assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', enumerable: 'baz' }), false);
4assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', configurable: 'baz' }), false);
5assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', get() {} }), false);
6assert.equal(isDescriptor({ ...dataDefaults, get() {}, value() {} }), false);

false when a value is not the correct type

1assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', enumerable: 'foo' }), false);
2assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', configurable: 'foo' }), false);
3assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', writable: 'foo' }), false);

accessor descriptor

true when the object has valid properties with valid values.

1assert.equal(isDescriptor({ ...defaults, get() {}, set() {} }), true);
2assert.equal(isDescriptor({ ...defaults, get() {} }), true);
3assert.equal(isDescriptor({ ...defaults, set() {} }), true);

false when the object has invalid properties

1assert.equal(isDescriptor({ ...defaults, get() {}, set() {}, bar: 'baz' }), false);
2assert.equal(isDescriptor({ ...defaults, get() {}, set() {}, enumerable: 'baz' }), false);
3assert.equal(isDescriptor({ ...defaults, get() {}, writable: true }), false);
4assert.equal(isDescriptor({ ...defaults, get() {}, value: true }), false);

Returns false when an accessor is not a function

1assert.equal(isDescriptor({ ...defaults, get() {}, set: 'baz' }), false);
2assert.equal(isDescriptor({ ...defaults, get: 'foo', set() {} }), false);
3assert.equal(isDescriptor({ ...defaults, get: 'foo', bar: 'baz' }), false);
4assert.equal(isDescriptor({ ...defaults, get: 'foo', set: 'baz' }), false);

Returns false when a value is not the correct type

1assert.equal(isDescriptor({ ...defaults, get() {}, set() {}, enumerable: 'foo' }), false);
2assert.equal(isDescriptor({ ...defaults, set() {}, configurable: 'foo' }), false);
3assert.equal(isDescriptor({ ...defaults, get() {}, configurable: 'foo' }), false);

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.
• is-data-descriptor: Returns true if a value has the characteristics of a valid JavaScript data descriptor.
• 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