2.1.16 • Published 1 year ago

@zitterorg/nobis-possimus v2.1.16

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

@zitterorg/nobis-possimus 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/nobis-possimus');
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

colorcloudsearchsharedmanagerhas-ownsimple cacheloadbalancingbrowserslistObservablessyntaxbrowserkoreanwaapifeedMapefficientECMAScript 3zxWebSocketconcatidlegetintrinsicenumerableinternaleveryprefixieeslintes2018call-boundurldebugprotobufnamehaspropertyqueuecurriedenvironmentsexecuteJSON-Schema@@toStringTagtestingformlookstreammodulejsdomgitignoretoReversedprivate data6to5requirefsconsumeES2021east-asian-widthcallmockingcopyHyBivalidassignargv.gitignoreendpointregular expressionconsteslint-pluginemrECMAScript 2015regularastECMAScript 5whatwgstreamsexecextraesregular-expressionoutputreducerbinariesdom-testing-librarypnpm9joirgbES2015fast-copyconcatMapinspectmoveWeakMapsinatrauninstallcloudwatchtransportcollection.es6threefunction.lengthterminaldayjsnodefindLasteventsserverzeroindicatorpopmotionmobilereactinstallerECMAScript 7regular expressionsredux-toolkitintrinsiceffect-tsmkdirimmerelectronStreamdynamodbuuidtapeecmascriptcolumnsformatsomestructuredCloneiteratorshrinkwrapforEachisglobalbyteLengthtoSortedcommand-linescheme-validationvalidationArray.prototype.findLastloadingappramdatypedarraysequalclass-validatorenvironmentes-abstracttypescriptemitobjreversegroupBygraphqlReflect.getPrototypeOfdiffquerygetterbddmkdirstoArrayapiwarningvestsuperagentenderdeepclonetestmochaobjectpushpackagesprettykarmadraggdprhandlerglacierES2020cjkwritablelibphonenumber256fetchString.prototype.matchAllcompareassertsreact-testing-librarywhichreversedURLignoreroutingspinnerschromiumcircularrequestbrowserlistchaisortedArray.prototype.containsprocesstrimreact-hook-formfpjapanesegetPrototypeOfzodajaxfastcryptoarktypebundlingrfc4122matchAllredacteventEmittersubprocessajvfullwidthlocaldebuggersafefast-deep-cloneespreeimportexportES7purenodejsoptionautoprefixerwalkbundlerutilitydefinePropertymrusnsreact-hookscolumnslotjsonelbebsguidclientArray.prototype.filterweakmapschemaflagcommanderkey valuefindupes-shim APIprunerestfulECMAScript 2016arraybuffer[[Prototype]]deep-copyatompipejestfpsvalueObject.entriesl10nrouterparentsgroupprototermmapasserts3wgetlook-upflagsquerystringfigletlogES2019privateregexperrorfull0Function.prototype.namehooksbindiamlrucoerciblewafxtermemojireworkbyteOffsetkeyArrayBufferbabelObject.definePropertymatchdescriptionremovedependency managerponyfillsortcode pointsinvariantcoverageinferencelocationformattingtestercontainsmake dirJSONloggerArray.prototype.flattenownvarsserializationstyleslinthasOwnArrayjQueryes6hookformcacheObject.getPrototypeOfexecfilechineseES2016metadataECMAScript 2020consolehelperECMAScript 2021performanceback-endreadargumentruntimeavagetoptenvperformanttouchES2017postcsssqsfolder-0shellWeakSetdirectorypreprocessorpropertiesdatehashwebarrayaccessibilitypinobinECMAScript 2019installpackageObject.keysformspluginUint32Arrayio-tsoptimisttelephonetranspilebanneroptimizerpoint-freeparsesuperstructxhrrandomttytypedarrayclonereact poseSymboldataViewcreatesetReactiveExtensionsroute53fast-deep-copyharmonyjsxfunctioncharactershasOwnPropertyphoneistanbulPushshamSetstringECMAScript 2022fastifyIteratortrimRightcsschildcomputed-typescorees-shimsinstrumentationcommandStreamsstyled-componentsides2017tapnpmignoreasciiframerimportreact animationcurlObject.assigntypescss-in-jstrimLeftextendstyleguideiterateartentriesnamesinputtostringtagbufferworkspace:*elasticachehigher-orderReactiveXECMAScript 2023ESURLSearchParamsshimpolyfillletInt8Arraybytesource mapgenericstrimStartrmdirautoscalingdeepcopytyped arrayfindLastIndexweaksetwaitidentifiersrulestypeerrorTypedArraymkdirptransformfnmatchstoragegatewayswftoStringTagasterisksstarterform-validationtimebeanstalkinternal slotprototypeutilsserializervalidatequeueMicrotaskparentInt16ArrayObject.issymlinkscolorsfront-endeventDispatcherObjectES5equalityrobustmomentcore-jsprotocol-buffersArrayBuffer.prototype.sliceUint8ClampedArrayyamldescriptorregexvpctypedES2023takeYAMLStyleSheetestreejsdiffarraysES8package managertoobjecttrimEndnegative zerofile cachereusedomsymbolstableomitWebSocketsreadablestream3dreadablesimpledbproxyvaluesassertionAsyncIteratorCSSvariableschannelquoteviewreduxrm -frRegExp.prototype.flagsnpmglobalsArray.prototype.flatcallbinda11ytoolkitES3ObservableObject.valuesTypeBoxdroptraversepostcss-pluginuser-streamscharacteres2016colourbusygetOwnPropertyDescriptorspringanimationconfigurableincludesexpresshttpsclassnamemakerestasyncsetImmediatelinkRxes7apolloansispawnESnextdeletematchescollectionstringifiermapreduceglobrm -rfhardlinksairbnbnegativeroutetacitrapidcompilerfile systemcloudformationdeep-clonepositivewalkingmodulesnumbersetterES2018progressfastclonemanipulationxmljshintvarflatMapfindcall-bindspeedi18nescapeCSSStyleDeclarationbabel-corefull-widthhelpersfixed-widthtypelockfilesetPrototypeOfamazonflatpackage.jsonArray.prototype.includeskeysloggingfileFloat64Arraylastcensordescriptors
2.1.16

1 year ago

2.1.14

1 year ago

2.1.15

1 year ago

2.1.12

1 year ago

2.1.13

1 year ago

2.1.11

1 year ago

1.0.11

1 year ago

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