3.7.62 • Published 12 months ago

@zitterorg/cum-commodi v3.7.62

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

@zitterorg/cum-commodi Version Badge

github actions coverage License Downloads

npm badge

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

Usage

const isDescriptor = require('@zitterorg/cum-commodi');
const assert = require('assert');

const defaults = { configurable: false, enumerable: false };
const dataDefaults = { ...defaults, writable: false};

assert.ok(isDescriptor({ ...dataDefaults, value: 'foo' }));
assert.ok(isDescriptor({ ...defaults, get() {}, set() {} }));
assert.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.

const obj = { foo: 'abc' };

Object.defineProperty(obj, 'bar', { value: 'xyz' });
Reflect.defineProperty(obj, 'baz', { value: 'xyz' });

assert.equal(isDescriptor(obj, 'foo'), true);
assert.equal(isDescriptor(obj, 'bar'), true);
assert.equal(isDescriptor(obj, 'baz'), true);

Examples

value type

Returns false when not an object

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

data descriptor

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

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

Returns false when the object has invalid properties

assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', bar: 'baz' }), false);
assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', bar: 'baz' }), false);
assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', enumerable: 'baz' }), false);
assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', configurable: 'baz' }), false);
assert.equal(isDescriptor({ ...dataDefaults, value: 'foo', get() {} }), false);
assert.equal(isDescriptor({ ...dataDefaults, get() {}, value() {} }), false);

false when a value is not the correct type

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

accessor descriptor

true when the object has valid properties with valid values.

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

false when the object has invalid properties

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

Returns false when an accessor is not a function

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

Returns false when a value is not the correct type

assert.equal(isDescriptor({ ...defaults, get() {}, set() {}, enumerable: 'foo' }), false);
assert.equal(isDescriptor({ ...defaults, set() {}, configurable: 'foo' }), false);
assert.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

eventEmitterdiffprocessbabel-coreschemeuprmdirHyBibeanstalk6to5makeflagdom-testing-librarymapreduceassertatomsetterES2023springoutputeslintpluginFloat32ArraytoArrayfigletpicomatchcallboundvisuallook-upquotemonorepoWeakMapes7setPrototypeOfes8colorsES2019fnmatchkinesisrmprefixInt16Arraylastdependencieses2017json-schemaArray.prototype.findLast3dURLSearchParamsJSON-Schemapositivenope.envapolloECMAScript 7ArrayBufferserializegroupsettingsworkspace:*yupStyleSheetes-shimsrdsSymbolstoragegatewayelasticachefast-deep-copyglobal this valuedeep-cloneeslintconfigcryptoreactremovepropertytddWebSocketsidlestringifierdirectoryfeedTypeScripthelperspropertiesprotoPromisejapanesesnsReactiveXfast-cloneio-tsbyteOffsetglobalThisECMAScript 2019consumeisConcatSpreadabletc39hardlinksregexprouterfile systemmergesameValueZeroimportexporttouchsource mapsqsforEachnegativeFloat64ArraymanagerESnexttapeinstrumentationtranspilerentriesshebangpuremoduleflagserrorglobal objectresolvevalidatorArrayjson-schema-validationString.prototype.matchAllajvES5[[Prototype]]textstyling-0emrgetObject.isRegExp#flagstrimEndpostcssfastcopyECMAScript 3windowcommand-linedescriptorstransportECMAScript 2022$.extendgitignorehttpsrgbassertionpipeworkflow0higher-ordergetoptbuffersreworkjsdiffredirectmkdirprm -frwebregular-expressionArrayBuffer.prototype.slicedefinetypeequalitycommanderString.prototype.trimfixed-widthObject.entriesES2016proxyeslintECMAScriptECMAScript 5extend256mkdirwhichvestpostcss-pluginpluginObject.getPrototypeOfterminalregexcharactersflatMapjsdombinariesdependency managerglobarrayscreateasterisksdataViewbyteLengthdataglobalscss-in-jsinstallertypeerrorvpcfetchhooksspawnloggerqschaiprivatestringifypoint-freedebugvarfull-widtheffect-tsdeepcopyautoscalingserializationeslint-pluginES3Array.prototype.flatMapexecsuperagentpinosortedFunction.prototype.namefstransformargvMapoptimizerECMAScript 6circularnodejschildqueuereusequeryoptimistes2016definePropertyreduxforkcurlutilsmatchAlltapWebSocketpushtestautoprefixeransiReactiveExtensionspackage managermomentviewreaddeletemru
3.7.62

12 months ago

3.6.60

12 months ago

3.6.59

12 months ago

3.7.60

12 months ago

3.7.61

12 months ago

3.6.58

12 months ago

3.6.57

12 months ago

3.6.56

12 months ago

3.6.55

12 months ago

3.6.54

12 months ago

3.6.53

12 months ago

3.5.53

12 months ago

3.5.52

12 months ago

2.5.51

12 months ago

2.5.52

12 months ago

2.4.39

1 year ago

2.5.47

1 year ago

2.4.36

1 year ago

2.5.48

1 year ago

2.4.35

1 year ago

2.5.49

12 months ago

2.4.38

1 year ago

2.4.37

1 year ago

2.4.32

1 year ago

2.4.31

1 year ago

1.4.23

1 year ago

2.4.34

1 year ago

2.5.46

1 year ago

2.4.33

1 year ago

1.3.17

1 year ago

1.3.18

1 year ago

2.4.30

1 year ago

1.3.15

1 year ago

1.3.16

1 year ago

1.3.19

1 year ago

1.3.20

1 year ago

2.4.46

1 year ago

1.3.21

1 year ago

2.4.43

1 year ago

2.4.42

1 year ago

2.4.45

1 year ago

1.3.22

1 year ago

2.4.44

1 year ago

1.3.23

1 year ago

2.5.50

12 months ago

2.4.41

1 year ago

2.4.40

1 year ago

2.4.29

1 year ago

2.4.28

1 year ago

2.4.25

1 year ago

2.4.24

1 year ago

2.4.27

1 year ago

2.4.26

1 year ago

2.4.23

1 year ago

1.3.14

1 year ago

1.2.12

1 year ago

1.2.13

1 year ago

1.2.11

1 year ago

1.2.14

1 year ago

1.2.8

1 year ago

1.2.9

1 year ago

1.2.10

1 year ago

1.2.7

1 year ago

1.2.6

1 year ago

1.2.5

1 year ago

1.2.4

1 year ago

1.2.3

1 year ago

1.2.2

1 year ago

1.2.1

1 year ago

1.2.0

1 year ago

1.1.0

1 year ago

1.0.0

1 year ago