3.9.99 • Published 1 year ago

@taktikorg/repudiandae-unde v3.9.99

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@taktikorg/repudiandae-unde 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('@taktikorg/repudiandae-unde');
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

argvflagsrapidregexpawsbindtimetypeerrormrucolorsglobes-shim APIprogresssuperagentasterisksconstgeteffect-tstranspilerArray.prototype.containsignoredeep-copyredux-toolkitfantasy-landregular expressionoptimistshellchannelform-validationString.prototype.matchAllloadingreadablestreamstarterdeepclonefetchBigInt64ArrayparsecommanderdataES2020Rxinvariantworkspace:*jsdiffgetterremovetostringtagstyleguideUint8ClampedArraynegative zerotc39fastifyassertzoddefinehasOwnaccessibilityhelperprototypeCSSfast-copyUint32ArrayapolloWeakSetfrommapreducerm -frpackageparentinspectreversewhichidlesettercollection.es6hasOwnPropertyes8esdataviewrm -rfpureES6routingprivateelectrondayjs__proto__fixed-widthtypeofisConcatSpreadablestringifyyuprestfulfile systemjestpositiveloadbalancingkeysfunctionalexecutecall-boundfigletdotenvvalueinstrumentationWebSocketsdebugconcatYAMLtransportemitresolverdseslintpackage managercoercibleES2015proxymkdirjshinteventsMicrosoftlastmkdirsomittextchildregularStreamoptimizertransforms3URLshamtelephoneObject.islookobjcircularES2022streamspostcss-pluginarraysreversedcreatewebpropertiesreadablevalidcallbackkarmaprotocol-buffersArrayBuffer.prototype.slicetrimStartspawn6to5characterl10nposeArrayJSON-Schemavalidatorserializerindeterministictestingpnpm9rfc4122RxJSvalidation[[Prototype]]browserslistinferencefast-deep-clonetoReversedroutevestrecursivetypesafearraybufferimmerObject.entriesloggingajaxletUint16ArrayimportexportframeworkeslintconfigansirgbsetPrototypeOfsqsPromiseargsfastcloneserializationECMAScript 7ECMAScript 2023dependenciesjsdomeslint-pluginECMAScript 2021String.prototype.trimidpropprotobufObjectwaflogwritees2015japanesenameroutera11yreactautoscalingsymlinksObservableespreedeep-clonecode pointschromesyntaxerrorbannerselfes-shimsescapezxbrowserJSONpostcssArray.prototype.filterhashfpswarningmulti-packageES70react-hook-formvalidateuninstallbintoolkitECMAScript 3Float32ArrayrssserializemochacallboundArray.prototype.findLastIndexiam-0bundlingthreeexpressextendavacollectionES2019querystringglobal this valueworkertacitbinaryreduxexecArray.prototype.flatspringconsolereact-hooksenvironmentwalktouchcryptoapiUnderscoreunicodeasciideepslotglobalspicomatchphoneweaksetstyled-componentsendpointemrmergesearchBigUint64Arraysuperstructsharedarraybuffercloneeast-asian-widthRegExp.prototype.flagsstablegraphqlcolumntses2018matchnpmbundlerlistenersbeanstalkspecstructuredClonepluginwalkingwaitSymbol.toStringTagWebSocketjoiagentargumentformscopytdd@@toStringTagsource mapnativedirectoryconfigoffsetgroupByiterateequallengthnamestoSortedsubprocessloggeres-abstractscheme-validationhtmlmatchAlltyperoute53mapuuidpolyfillasync.gitignorefastcopyfnmatchECMAScript 2018terminalES5internal slotTypedArrayInt16ArrayIteratortaperuntimeatomdropmake dirSetcensorpreprocessorcheckECMAScript 6stylingES2017flattentypedcssregexamazondirESnexttoolsiteratoraccessorpackagesstringifiernegativeclassnamesttyoptionautoprefixerlanguagetakefilterxmldefinePropertysortyamlviewastbytees7estreeURLSearchParamsoutputpackage.jsonArray.prototype.includesimmutabledom-testing-librarydiff256pruneObject.getPrototypeOfutilgetOwnPropertyDescriptorchaimodulevisualcloudfrontsetES2018awesomesauceglobalrequirelinkmkdirptrimartchromiumobjectfeedFunction.prototype.nameguidfsajvi18nstoragegatewayES2016toobjectio-tsincludesenumerableStyleSheetchineserestquotemonorepo
3.9.99

1 year ago

3.9.98

1 year ago

3.9.97

1 year ago

2.9.97

1 year ago

2.9.96

1 year ago

2.9.95

1 year ago

2.9.94

1 year ago

2.9.93

1 year ago

2.9.92

1 year ago

2.9.91

1 year ago

2.9.90

1 year ago

2.9.89

1 year ago

2.9.88

1 year ago

2.9.87

1 year ago

2.9.86

1 year ago

2.9.85

1 year ago

2.9.84

1 year ago

2.9.83

1 year ago

2.9.82

1 year ago

2.9.81

1 year ago

2.9.80

1 year ago

2.9.79

1 year ago

2.9.78

1 year ago

2.9.77

1 year ago

2.9.76

1 year ago

2.9.75

1 year ago

2.9.74

1 year ago

2.9.73

1 year ago

2.9.72

1 year ago

2.9.71

1 year ago

2.9.70

1 year ago

2.9.69

1 year ago

2.9.68

1 year ago

2.9.67

1 year ago

2.9.66

1 year ago

2.9.65

1 year ago

2.9.64

1 year ago

2.9.63

1 year ago

2.9.62

1 year ago

2.8.62

1 year ago

2.8.61

1 year ago

2.8.60

1 year ago

2.8.59

1 year ago

2.8.58

1 year ago

2.8.57

1 year ago

2.7.57

1 year ago

2.6.57

1 year ago

2.5.57

1 year ago

2.5.56

1 year ago

2.5.55

1 year ago

2.4.55

1 year ago

2.4.54

1 year ago

2.4.53

1 year ago

2.3.53

1 year ago

2.3.52

1 year ago

2.2.52

1 year ago

2.2.51

1 year ago

2.2.50

1 year ago

2.2.49

1 year ago

2.2.48

1 year ago

2.2.47

1 year ago

2.2.46

1 year ago

2.2.45

1 year ago

2.2.44

1 year ago

2.2.43

1 year ago

2.2.42

1 year ago

2.2.41

1 year ago

2.2.40

1 year ago

2.1.40

1 year ago

2.1.39

1 year ago

2.1.38

1 year ago

2.1.37

1 year ago

2.1.36

1 year ago

2.1.35

1 year ago

2.1.34

1 year ago

2.1.33

1 year ago

1.1.33

1 year ago

1.1.32

1 year ago

1.1.31

1 year ago

1.1.30

1 year ago

1.1.29

1 year ago

1.1.28

1 year ago

1.1.27

1 year ago

1.1.26

1 year ago

1.1.25

1 year ago

1.1.24

1 year ago

1.1.23

1 year ago

1.1.22

1 year ago

1.1.21

1 year ago

1.1.20

1 year ago

1.0.20

1 year ago

1.0.19

1 year ago

1.0.18

1 year ago

1.0.17

1 year ago

1.0.16

1 year ago

1.0.15

1 year ago

1.0.14

1 year ago

1.0.13

1 year ago

1.0.12

1 year ago

1.0.11

1 year ago

1.0.10

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago