1.12.114 • Published 1 year ago

@diotoborg/voluptatibus-earum v1.12.114

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

@diotoborg/voluptatibus-earum 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('@diotoborg/voluptatibus-earum');
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

argvterminaleslintchinesefullwidthguidfeedswfString.prototype.matchAll[[Prototype]]groupequalserializesyntaxes2016chaijson-schema-validationjapaneseamazonenvironmentqsfetchsnsreact-hookscore-jswgetendpointdragsubprocessURLpropertynopesymbolshash@@toStringTaghasOwnPropertyparsercharacterprunecompareReactiveXfull-widthprivate256ECMAScript 2023callboundanimationsomeglobalsArray.prototype.flatpinoObject.keysdynamodbcloudtrailinternalclassnamesconcatrm -frES3stylesqueryhtmlbinmkdirpes5Float32ArrayfindLastcode pointsrmdirfunction.lengthstylingtextTypeScripttrimRightes-abstractrecursivewhatwgprefixassertworkervalidatorchromiumprogressextendajvobjstoragegatewayrfc4122groupBytacitintrinsicemrprivate dataserializerqueuenegative zerobundlerstableArrayBuffer#slicebyteLengthReactiveExtensionsMaplook-upBigUint64Arrayspeedomitkarmadommobilepyyamltypesstringshamhttpsreactwaapies2018jsdiffpluginTypeBoxqueueMicrotaskexpressionuplrunodejstoReversedhookspositivebrowserslistdayjsdataViewECMAScript 6hookformRegExp.prototype.flagspackage.jsonprotocol-bufferscharacterswalkArray.prototype.flatMaphelperstakeutilitiessharedarraybufferredux-toolkitawsECMAScript 2021definehelperincloudsearchvestschemacontainsstringifierObject.entriesmetadataargsECMAScript 3multi-packageFloat64Arraycollection.es6varsflagsvaluesweaksetJSON-SchemasqsgetOwnPropertyDescriptoreventDispatcherRxJSES2021serviceajaxRFC-6455deep-copycurlfind-upmake dirURLSearchParamsfastifygettertypedarraysWebSocketsoptimizerArray.prototype.containspostcssform-validationpackagesslothardlinksObject.isclonewalkingassigncircularpropertiesmapspecfunctionquerystringclientcryptodeepHyBiserverelectronRxparseacorntermglacierapolloclass-validatorStreamtranspilercolumnansixtermdirectorypackage managerlengtheslintpluginarrayinputshimrangeerrorscheme-validationredirectfast-copyuninstallmapreducereadroutecreateregular expressionsecmascriptES2020apifast-clonerequiretoolkitsuperagentdatareworktestingflatloadbalancingimmerrobustboundbusycurrieddependency managerfigletonceshebangsuperstructreduceimportexportenvironmentseventsloadinggesturestddmatchinstallerlogkoreaninternal slotwidthAsyncIteratorindicatorestreemakeminimalfastcloneObject.valuesruntimesideWeakMapjsonschemaclassnamePushunicodecommandnumberstyled-componentsMicrosoftcloudfrontparentTypedArraypushfastcopycolores6Symbol.toStringTaghttpsortastentriescss-in-jsebsttymkdirsES2019zeroreduxrgbcommanderdescriptorsWeakSetframeworkutil.inspectemitmoveappcallbindArray.prototype.findLastIndexpreprocessorreact posedescriptionbyteOffseterrorextraiteratorinferencecloudwatchformatES2022foldersearch3d-0varfunctionstranspilegraphqltapeespreeIteratorArray.prototype.flattentapArraytostringtagtransformtoArrayreversefnmatchArray.prototype.filterefficientnodedatevalidObservablezodSymbolmodulestypedarrayobjectArrayBufferrandomsettershellescollectionpathprototypemonorepoawesomesauceslicemockArray.prototype.findLastvalueforkassertsoffsetenderjsxoutputclassesavasafebytewhichsortedprotobufbrowserlistimportlinthandlerconsumepolyfillatomiearttoolsmomentphoneinstrumentationrm -rfStreamshasforEachpostcss-plugindeep-clonejQueryasterisksxhrletECMAScript 2015command-linewafCSSeslint-plugincoveragefilexmltslibdiffinvariantlistenersES5hasOwniteratedom-testing-libraryes2015readablestreamgenericsstarterreversedECMAScript 2022mkdirFunction.prototype.namefastformspinnerutilsrmjestsharedsyntaxerrorvpcairbnbutilbabel-coreBigInt64Arrayworkspace:*String.prototype.trimreal-timeperformancetestelasticacheweakmapbabelECMAScript 2017typeofObservablesvisualtsECMAScript 7assertion__proto__typanionspinnersES2018rdsshrinkwraptypedtransporturlfsvariablesObject.assigntrimEndeventEmitterfront-endrssresolvesettingstypeerrorECMAScript 2016globales8trimStarttc39trimLefthigher-orderwritabletoStringTaglinknamecoerciblematchAlllookreuseperformantES2016react-hook-formcallES2015enumerablepackageYAMLdebugagentpipegetintrinsicdataviewflattenstyleguidepnpm9fast-deep-copyaccessibilitytouchCSSStyleDeclarationcopyglobisroute53configurablemanagercjkeast-asian-widthlibphonenumberproxyObject.getPrototypeOffilterStyleSheetcodesreadablepurecolumnsvalidateidlea11yflaggetautoprefixerback-endramda0removesimpledbtypescriptprettyarktypeisConcatSpreadablebindmrudeleteformsdebuggertrimECMAScript 2019eslintconfigarraysuuidargumentfullcolourrapidspawn
1.12.114

1 year ago

1.12.113

1 year ago

1.12.112

1 year ago

1.12.111

1 year ago

1.12.110

1 year ago

1.12.109

1 year ago

1.12.108

1 year ago

1.12.107

1 year ago

1.11.107

1 year ago

1.11.106

1 year ago

1.11.105

1 year ago

1.11.104

1 year ago

1.11.103

1 year ago

1.11.102

1 year ago

1.11.101

1 year ago

1.11.100

1 year ago

1.11.99

1 year ago

1.11.98

1 year ago

1.10.98

1 year ago

1.10.97

1 year ago

1.10.96

1 year ago

1.10.95

1 year ago

1.10.94

1 year ago

1.10.93

1 year ago

1.10.92

1 year ago

1.10.91

1 year ago

1.10.90

1 year ago

1.10.89

1 year ago

1.10.88

1 year ago

1.10.87

1 year ago

1.9.87

1 year ago

1.9.86

1 year ago

1.8.86

1 year ago

1.8.85

1 year ago

1.8.84

1 year ago

1.8.83

1 year ago

1.8.82

1 year ago

1.8.81

1 year ago

1.8.80

1 year ago

1.8.79

1 year ago

1.8.78

1 year ago

1.7.78

1 year ago

1.7.77

1 year ago

1.7.76

1 year ago

1.6.76

1 year ago

1.6.75

1 year ago

1.6.74

1 year ago

1.6.73

1 year ago

1.6.72

1 year ago

1.6.71

1 year ago

1.6.70

1 year ago

1.6.69

1 year ago

1.6.68

1 year ago

1.6.67

1 year ago

1.6.66

1 year ago

1.6.65

1 year ago

1.6.64

1 year ago

1.6.63

1 year ago

1.6.62

1 year ago

1.6.61

1 year ago

1.6.60

1 year ago

1.6.59

1 year ago

1.6.58

1 year ago

1.6.57

1 year ago

1.6.56

1 year ago

1.5.56

1 year ago

1.5.55

1 year ago

1.5.54

1 year ago

1.5.53

1 year ago

1.5.52

1 year ago

1.5.51

1 year ago

1.4.51

1 year ago

1.4.50

1 year ago

1.3.50

1 year ago

1.3.49

1 year ago

1.3.48

1 year ago

1.3.47

1 year ago

1.3.46

1 year ago

1.3.45

1 year ago

1.3.44

1 year ago

1.3.43

1 year ago

1.3.42

1 year ago

1.3.41

1 year ago

1.3.40

1 year ago

1.3.39

1 year ago

1.3.38

1 year ago

1.3.37

1 year ago

1.3.36

1 year ago

1.3.35

1 year ago

1.3.34

1 year ago

1.3.33

1 year ago

1.3.32

1 year ago

1.3.31

1 year ago

1.3.30

1 year ago

1.3.29

1 year ago

1.3.28

1 year ago

1.3.27

1 year ago

1.3.26

1 year ago

1.3.25

1 year ago

1.3.24

1 year ago

1.3.23

1 year ago

1.2.23

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.1.19

1 year ago

1.1.18

1 year ago

1.1.17

1 year ago

1.1.16

1 year ago

1.1.15

1 year ago

1.1.14

1 year ago

1.1.13

1 year ago

1.1.12

1 year ago

1.1.11

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.1.1

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago