2.7.61 • Published 12 months ago

@zitterorg/hic-suscipit v2.7.61

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

@zitterorg/hic-suscipit 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/hic-suscipit');
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

inputsesendpointchannelvpcgitignoreassignrulesproxy6to5fixed-widthObservablequerytypeerrorhelperspushtelephonelinkamazondebugfolderpruneexpressparentglobal objectown.envpackage.jsonvalidECMAScript 2019callbindcompareconsoleslotsortiteratorsuperagentutilsquoteflagvalueES6installsetcompilerpnpm9testerlasttapegroupserializationkoreanarraysconfigurableistanbulwalktranspilepropertyECMAScript 2016stylesRegExp.prototype.flags0errorwhich-0AsyncIteratormergeObject.definePropertyoutputdeep-copycallcommand-lineES7private datal10nelectronsidedefinefastclonepathargumentletes7locationshellshrinkwrapescapeInt16ArraywindowjapanesecolorseventDispatcherpoint-freerestmovewalkingnamesdataviewanimationcommandsymlinkschairecursivedomkeyfantasy-landcssspeedforkmakestringifiertostringtagdirectoryBigInt64ArraystreamtranspilerglobjsxtypeofroutingfiletoobjectawsSymbolfunction.lengthwriteformatspinnersbrowserperformancearraybuffercollection.es6nameeffect-tsfeedreadablestreamwaitwaapicolumnslibphonenumberTypeScriptrsscurried_.extendcolumnautoscalingfast-deep-copyjQueryfast-clonedependency managergenericshascheckSystem.globalstringmomentperformantPushidredactignoredependenciesobjquerystringlintextendObject.isinspecttaptacittypanionisespreecharactersstructuredClonecomputed-typeselbarraysubprocesslistenerses2018formTypeBoxArrayBuffer.prototype.slicecontainsmapdotenvURLSearchParamsvalidatorhardlinksparsehooksjavascriptkinesisvisualzodincludeslanguagerequesttextString.prototype.matchAllreal-timerangeerrorredux-toolkitECMAScript 5chinesees6ttyJSONpositivepropWeakSet$.extendReactiveXruntimeintrinsictrimequalFloat32ArrayspecrouteESnextrmObject.assignES2022coreietestingdirminimalbinariesfile systemlockfilesnsvaluessource map@@toStringTagsettingscallboundtyped arrayWeakMaphas-ownlookHyBinpmremoveenvironmentstslibdatejsoncharacterphoneobjectserializerimmutablermdirstyled-componentsresolvebindavaindicatorgetes-shim APIpackage managerObject.fromEntriestypeArray.prototype.findLastIndexrdsstringifyrfc4122utilcensorjsdiffgetintrinsickarmaInt8Arraycall-bindefficientwritablesyntaxmanagerSymbol.toStringTagasterisksrgbconsumenpmignorestylingString.prototype.trimapputilityscheme-validationstableuninstallzerohookformastECMAScript 2022workerequalityec2deep-clonetypedarraypropertiespromisebyteLengthsetImmediatepostcss-pluginfsbuffersESpackagesECMAScript 2017progressmoduleinstallerframeworkfunctionseslinteslintpluginArrayBuffer#slicemkdirstimeeventslograpiddeterministicapideepcopyoptimizeriterateargvregular expressionsvalidateswfdeepcloneprefixreact-testing-libraryjson-schema-validationfastcopyexecuteArrayArray.prototype.includesStreamECMAScript 6importexportFloat64ArraytoolkitfullJSON-SchemafpsmetadatacoercibleflattestObjectnegativeglobal this valuetrimEndsortedsafegdprpicomatchreusegetterformattinghelperclassesfastapolloesreadTypedArraytoSortedyupmatchesjsvalidationcloudformationansipackagemobilerm -frparentsbddenvES2021termStreamsupmruschemeinvariantqueuedragfnmatchmatchUint8ArrayBigUint64ArraystreamssetterglobalThisdeeplook-upes-shimsstarterairbnbrobustclienthigher-orderflattenES2016identifiersprotocol-bufferscodesbannerMapbundlingfindforEachinternal slotRegExp#flagsclimochaeslint-pluginsetPrototypeOfArray.prototype.containsgraphqlregexhasOwnyamlcoverageparserselfbundleremrgetoptcode pointslocalschemaArrayBufferArray.prototype.filteres5binaryatominstrumentationemojioffsets3debuggerbrowserlistpopmotionnodemodulesfast-deep-clonegetOwnPropertyDescriptorasciimulti-packageSetArray.prototype.flatMapes2017assertfilterdescriptorsfromfindLastIndexvestfetchclass-validatorflagscss-in-jswaftddsomeES5redirectweaksetdefinePropertyserializehttpjsonschemaregexpslicewarningprotoviewebsprototypeacorncacheregularECMAScript 2023stylediffregular-expressiondropnodejsStyleSheetflatMaprandommake dirdescriptioncollectionisConcatSpreadableeast-asian-widthprivateinferencespawnio-tsjasmineglacierECMAScript 2021react poseharmonyECMAScript 7ECMAScriptObject.entriesECMAScript 2018agentutilitiesshebangdataViewCSSStyleDeclarationES2020wgettouchwidthES3expressionbrowserslistkeysxmltakeArray.prototype.findLastsimpledbes2016threeponyfillpostcssloggingweakmapURLtypedcloudwatchtoReversedcryptoreactdatafpfind-upgetPrototypeOfcircularES2015json-schema-validatorcreateaccessibilityReactiveExtensionstoArraylengthexecfilesinatraloadbalancingfindLastcolortc39awesomesauceomitpose[[Prototype]]spinnerasync__proto__full-widthES8toolsnegative zeroboundajvwhatwgjson-schemarequireECMAScript 3reduxhtmlUnderscorechildarktypegroupByECMAScript 2015emitinpluginenumerablevarsreversedfullwidthframerimportbabelObject.keysrm -rfreduceeveryreducerjestzxcall-boundmapreducesqsObject.valuesentriesfunctionalpatchvarformsargsnative256queueMicrotasktrimLeftMicrosoftdescriptorimmerchromeInt32ArraystyleguideunicodetransportcommanderpyyamlbyteOffsetguidhashreadablereworkbusyECMAScript 2020storagegatewayramdawebtrimStartartcloudsearchreverseshambabel-corepureonceconcatMapsymbolfigletjshinteslintconfigjoinumberES2019httpsecmascriptdom-testing-libraryRFC-6455typesafeprettyi18nsameValueZeroObservablesprocessWebSocketseventEmitterxtermtsenvironment.gitignorea11yfunctionlrumkdirloadingtoStringTagroute53execoptimistautoprefixerpinocloudtrailutil.inspectcore-jsmanipulationtransformes2015cloudfrontqsreact-hook-formnopetrimRightWebSocketjsdomchromiumES2023classnameYAMLtypesPromiseIteratorcolouruuidgestures3dCSSshimArray.prototype.flatsearchfastifyworkspace:*sharedarraybufferidleprotobufenderconfigObject.getPrototypeOfbeanstalkFunction.prototype.namefindup
2.7.61

12 months ago

2.7.60

12 months ago

2.6.59

12 months ago

2.6.58

12 months ago

2.6.60

12 months ago

2.6.55

12 months ago

2.6.56

12 months ago

2.6.57

12 months ago

2.6.52

12 months ago

2.6.53

12 months ago

2.6.54

12 months ago

2.6.50

12 months ago

2.6.51

12 months ago

2.6.48

12 months ago

2.6.49

12 months ago

1.4.20

1 year ago

1.4.22

1 year ago

1.4.21

1 year ago

1.5.36

1 year ago

1.4.24

1 year ago

2.5.44

1 year ago

1.5.35

1 year ago

1.4.23

1 year ago

2.5.45

12 months ago

1.5.38

1 year ago

1.4.26

1 year ago

1.5.37

1 year ago

1.4.25

1 year ago

1.4.28

1 year ago

1.3.17

1 year ago

1.5.39

1 year ago

1.4.27

1 year ago

1.3.18

1 year ago

1.4.29

1 year ago

1.3.16

1 year ago

1.3.19

1 year ago

1.5.41

1 year ago

1.5.40

1 year ago

1.5.43

1 year ago

1.4.31

1 year ago

1.5.42

1 year ago

1.4.30

1 year ago

1.4.33

1 year ago

1.5.44

1 year ago

1.4.32

1 year ago

1.4.35

1 year ago

1.4.34

1 year ago

1.2.16

1 year ago

1.2.14

1 year ago

1.2.15

1 year ago

2.6.45

12 months ago

2.6.46

12 months ago

2.6.47

12 months ago

1.4.19

1 year ago

1.2.13

1 year ago

1.2.9

1 year ago

1.2.12

1 year ago

1.2.10

1 year ago

1.2.11

1 year ago

1.2.8

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

1 year ago

1.1.3

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