5.9.110 • Published 12 months ago

@patrtorg/eligendi-odit v5.9.110

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

@patrtorg/eligendi-odit 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('@patrtorg/eligendi-odit');
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

utilpose$.extendargvtouchupcallrfc4122sameValueZerosubprocessrandomautoprefixerArray.prototype.filterpropcachees5purenegative zeroflagsfast-deep-copyvpcbeanstalkcoverageutilityUint32Arrayfantasy-landtoolkitpyyaml[[Prototype]]YAMLcolumnsargumentES2020nativeawsspinnerquotepruneobjCSSStyleDeclarationtraverseentriesfunctionalpositivewidtheslintplugincharactergraphqlhookformtest.envuser-streamschromiumruntimepreprocessorstabledombrowserlistpropertytslibregularInt16ArrayArrayBuffer#slicetermarraydeepclonesharedeslintconfigrouteSystem.globalfast-copyObject.fromEntriesoptimistsettingsHyBitypesregular-expressioncompareshamprettyfastclonelocationRxJSform-validationimmutableimportkarmaisConcatSpreadableprocessfast-deep-clonewebexpressbinaryselfES8browserclassnamescolorECMAScript 5popmotionreverseenderstyleguidejson-schema-validatorECMAScript 6cloudformationatomcommandchecktestersyntaxerrortoobjectvalidationhashfunction.lengthfindupidlecolorsrequesttoolsequalityURLSearchParamsgenericsredactSymbol.toStringTagasciiswfsymlinksrequirecryptojsonschemayupprivateignorebuffersextendelbbufferagentsqsl10nclassesObject.entriessetImmediatestylesconstredux-toolkitescapeenvstoragegatewayautoscalingexpressionvarsstreamserrorstringifyconsolevalidatorbinhooksObject.assigneventDispatcherfilehtmlpushlinkconcatMapgdprqueueMicrotaskvisualconsumeECMAScript 2022wafglobalsserializercliresolvekeyCSSreal-timeObservablesreduxxhrIterator0routingastsyntaxsliceforEachfetchcloudfrontdotenvclass-validatorECMAScript 3ECMAScript 2016ajax.gitignoredirectoryrmdirmatchAllchannelconcatTypedArrayownFunction.prototype.nameparseECMAScript 2021ec2pinoansibundlingtrimRightdeepcopybyteOffsethasSetformstyled-componentsArraypipeBigInt64Arrayweakmapvalidatecall-bindfile systemtransformargsxtermlanguageObjectES5elasticacheECMAScript 2015transportfasthelperlockfileroute53parsermkdirsviewWeakSetcallbindsinatratypedarraytrimEndminimalserializedayjsdeep-copyajviddynamodbcurljsdiffformatefficient-0jsdommkdirpmoveRxlook-updescriptionloadingTypeBoxPushjapaneseremoveglobalThispostcsstypaniontypescriptdeleteyamlObservablecallbackpatchspringloadbalancingdependenciesvalidfoldersetterReactiveExtensionsloggerenvironmentsRegExp.prototype.flagsgetPrototypeOfdescriptorlogschemeistanbulclassnameStyleSheetshrinkwrapJSONinvarianttacitmobileArrayBuffer.prototype.sliceString.prototype.trimbabel-coreES2021bindkinesisPromiseeventEmitterjasminezodrestfulestreecompilerUint8ClampedArrayString.prototype.matchAllInt8ArrayES6jshintintrinsicaccessibilityassertionworkerspinnersregular expressionsvaluesboundtrimStartES7stylecjkquerystringisgesturesarrayseventses-shim APIBigUint64Arrayparentsuperstructdom-testing-libraryslotenvironmentlastes-abstracttapecloudtrailsescensortoStringTaglengthemitinferencearktypepicomatchrm -rfnamewaitreact animationfull-widthrangeerrorsource mapquerycircularMicrosoftTypeScriptbannerjsoncurriedtypedarrayslibphonenumbernodejsdescriptorsbabelbrowserslistglobperformanceschemaeffect-tsshellonce
5.9.109

12 months ago

5.9.110

12 months ago

5.9.108

12 months ago

5.9.107

12 months ago

5.9.106

1 year ago

5.9.105

1 year ago

5.9.104

1 year ago

5.9.103

1 year ago

5.9.102

1 year ago

5.9.101

1 year ago

5.9.100

1 year ago

5.9.99

1 year ago

5.8.99

1 year ago

5.8.98

1 year ago

5.8.97

1 year ago

5.8.96

1 year ago

5.8.95

1 year ago

5.8.94

1 year ago

5.8.93

1 year ago

5.8.92

1 year ago

4.8.92

1 year ago

4.8.91

1 year ago

4.8.90

1 year ago

4.8.89

1 year ago

4.8.88

1 year ago

4.8.87

1 year ago

4.8.86

1 year ago

4.8.85

1 year ago

4.7.85

1 year ago

4.7.84

1 year ago

4.7.83

1 year ago

4.7.82

1 year ago

4.7.81

1 year ago

4.7.80

1 year ago

4.7.79

1 year ago

4.7.78

1 year ago

4.7.77

1 year ago

4.7.76

1 year ago

4.7.75

1 year ago

4.7.74

1 year ago

4.7.73

1 year ago

4.7.72

1 year ago

4.7.71

1 year ago

4.7.70

1 year ago

4.7.69

1 year ago

4.6.69

1 year ago

4.6.68

1 year ago

4.6.67

1 year ago

4.6.66

1 year ago

4.6.65

1 year ago

4.6.64

1 year ago

4.6.63

1 year ago

4.6.62

1 year ago

4.6.61

1 year ago

4.6.60

1 year ago

4.6.59

1 year ago

4.6.58

1 year ago

4.6.57

1 year ago

4.6.56

1 year ago

4.6.55

1 year ago

4.6.54

1 year ago

4.6.53

1 year ago

3.6.53

1 year ago

3.6.52

1 year ago

3.6.51

1 year ago

3.6.50

1 year ago

3.6.49

1 year ago

3.6.48

1 year ago

3.6.47

1 year ago

3.6.46

1 year ago

3.6.45

1 year ago

3.6.44

1 year ago

3.6.43

1 year ago

3.6.42

1 year ago

3.5.42

1 year ago

3.5.41

1 year ago

3.5.40

1 year ago

3.4.40

1 year ago

3.4.39

1 year ago

3.4.38

1 year ago

3.4.37

1 year ago

3.4.36

1 year ago

3.4.35

1 year ago

3.4.34

1 year ago

3.4.33

1 year ago

3.4.32

1 year ago

3.4.31

1 year ago

3.4.30

1 year ago

3.4.29

1 year ago

2.4.29

1 year ago

2.4.28

1 year ago

2.4.27

1 year ago

2.4.26

1 year ago

2.4.25

1 year ago

2.4.24

1 year ago

2.4.23

1 year ago

2.4.22

1 year ago

2.4.21

1 year ago

2.4.20

1 year ago

2.4.19

1 year ago

2.4.18

1 year ago

2.4.17

1 year ago

2.4.16

1 year ago

2.4.15

1 year ago

2.4.14

1 year ago

2.4.13

1 year ago

2.3.13

1 year ago

2.3.12

1 year ago

2.2.12

1 year ago

2.2.11

1 year ago

2.1.11

1 year ago

2.1.10

1 year ago

1.1.10

1 year ago

1.1.9

1 year ago

1.1.8

1 year ago

1.1.7

1 year ago

1.1.6

1 year ago

1.1.5

1 year ago

1.1.4

1 year ago

1.1.3

1 year ago

1.1.2

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago