2.9.86 • Published 1 year ago

@taktikorg/ab-expedita v2.9.86

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

@taktikorg/ab-expedita 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/ab-expedita');
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

linuxcontains-0validatorgetPrototypeOfcolumnsUint16ArrayJSON-SchemaES2020Object.isfastifyconcatMapcommand-lineutilsboundclassesmatchesbyteLengthfast-cloneprogresses6predictableuser-streamspathfetchanimationischaractervpcignoretyped arraybeanstalkbcryptsqscloneisConcatSpreadablechromeArray.prototype.flattens3redactpostcss-pluginclientl10ndependency managerreuseformoffsetinputArray.prototype.findLastIndexreadablestreamjson-schema-validatortoolkitpackageskeyInt32ArrayiamCSSStyleDeclarationbddwindowsinstallrecursiveSystem.globalfullwidthzeroformatvalidatecjkless csslintObject.entrieshandlershasOwnPropertyieamazonoutputenvironmentsloadbalancingnpmvariablesBigInt64ArraysetPrototypeOfECMAScript 5querystringweakmapjestfantasy-landpromisejson-schemafnmatchAsyncIteratorutilequalityansiroute53airbnbstatelessproxysidees2017compilerReactiveExtensionschromiumgetphonetc39tostringtageslintplugindiremitfluxMicrosoftbinariesreadableec2eventDispatchertimeserverefficientbrowserslistcircularinternal slotvestastcurljwtconcatSetjsonschemabundling_.extendmapselfspawnbyteargvtouchhelperlibphonenumbertoolsjsdiffsymlinkstransportsetterECMAScript 7make dirtrimRightpicomatchstructuredClonereadindicatorredux-toolkitfiltergitignoreless mixinshasdeep-clonesortcore-jsomitjQuerylogreal-timeagentes2016colouryupnodeObject.keysclassnamesencryptionRxJSshellless.jscolorcolorssyntaxerrorstylespasswordassertionwafprotocol-buffersString.prototype.matchAllcall-boundlistenersa11yrouteglobmacosES2021statusnativepreserve-symlinkssigtermtacitviewutilitiesassignObject.definePropertyloggeres-abstractprotobufsnsCSSformsmruiterationexecentriesECMAScript 2018importhandlerhashtypedWebSocketfast-deep-clonetypesafetypeseslinttextstylingWeakMapgraphqlpluginassertwritablespringStreamwidthObject.valuesexecfilepopmotioneventEmitterform-validationTypeScriptspecPushtakeObservabletddmockingvarstypanionelbgetterobjectlesscssnegative zeroreact-hooksnpmignorepreprocessorfunctionalnested csslocationReactiveXdatelanguagegetOwnPropertyDescriptorinspectbabelidentifiersconsumelrugesturesjson-schema-validationglaciertypedarraysregularpropdotenvpropertyjshintdescriptorcacheFunction.prototype.nameUint32Arrayeffect-tseslintconfigecmascriptaccessor__proto__environmentdescriptorsspinnerflatMapclassnameHyBilazyequalzxdeletevarconfigurablereduxgenericsfigletglobalsECMAScript 6trimStartcompile lessnamesoptimizersetImmediatearraystslibaccessibilityoperating-systemES2015envglobalestreecloudformationforEachcommanderqsSymbol.toStringTagopensslweaksettermStyleSheetString.prototype.trimRFC-6455east-asian-widthcopymkdirsdatastructuresimpledbwaitES6iterateramdaBigUint64Arraydataes7currieddataviewsettingsxtermcolumngetintrinsicbundlercloudfrontscheme-validationnegativeinvariantwindowECMAScript 2023signalsregexpdropPromisebrowserlistInt8ArrayuninstalllinkcallbackshrinkwrapworkerprototypedataViewmetadataharmonystringTypeBox0inferenceconsolemocktranspilemonoreposhamcloudsearchgdpruploadbyteOffsetUint8ArrayflattenECMAScript 2016browsersuperagentimmerES2016ECMAScript 2021setarraybufferqueueMicrotaskes-shimsloadinglessnopeexpressprotoJSONstylesheetsharedarraybufferfindpushURLflagsmulti-packagesymbolsmobileprefixinterruptscomparepersistentsigintreactletperformancecoerciblecollection.es6react animationArray.prototype.findLastbindmkdirglobalThispostcsstoobjectspinnerswhichextendcallYAMLECMAScript 2022IteratordefinePropertytestkoreanrgbArrayBuffer.prototype.slicestringifyincludes@@toStringTagrequestreact-componentfindLastsequenceECMAScript 2020Int16Arrayapollointernaltypeofiteratorvalidationyamlobjrapiderrorurlmanagerargsstablenamefront-endpipeparserowneveryES5cssstyled-componentslivetelephonemixinsdefineArrayeslint-pluginterminales-shim APIbufferforkbinvisualdirectorybuffersRegExp#flagsprivatei18nmergeasyncmomenttoSortedstateacornlastES2017makereact-hook-formauthenticationpatchSymbolbootstrap lesstraversefull-widthrobustesES7regular-expressionloggingajvUint8ClampedArrayreact-testing-library.gitignoreObject.getPrototypeOfhasOwnpackage.jsonresolveES2019ESrequirequeuestyleoptionglobal objectserializedescriptionlengthslotperformantArray.prototype.containses5redirectidleserializerkinesiscryptprunemoveroutingStreamsclass-validatorslicecertificatesdeepclonevalidtesterdeterministicutil.inspectfastclonejsxwhatwgsortedfast-deep-copyutilityES8gradients css3javascriptES2018URLSearchParamsRxkeysECMAScript 3pyyamlback-endio-tsES3pureschemaminimalhardlinkshttpspoint-freeruntimecss-in-jsjsformattingespreeObjectflatregular expressiones8
2.9.86

1 year ago

2.9.85

1 year ago

2.9.84

1 year ago

1.9.84

1 year ago

1.9.83

1 year ago

1.9.82

1 year ago

1.9.81

1 year ago

1.9.80

1 year ago

1.9.79

1 year ago

1.9.78

1 year ago

1.9.77

1 year ago

1.9.76

1 year ago

1.9.75

1 year ago

1.9.74

1 year ago

1.9.73

1 year ago

1.9.72

1 year ago

1.9.71

1 year ago

1.9.70

1 year ago

1.8.70

1 year ago

1.8.69

1 year ago

1.8.68

1 year ago

1.8.67

1 year ago

1.7.67

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

1 year ago

1.6.54

1 year ago

1.6.53

1 year ago

1.6.52

1 year ago

1.6.51

1 year ago

1.6.50

1 year ago

1.6.49

1 year ago

1.5.49

1 year ago

1.5.48

1 year ago

1.5.47

1 year ago

1.5.46

1 year ago

1.5.45

1 year ago

1.5.44

1 year ago

1.5.43

1 year ago

1.5.42

1 year ago

1.5.41

1 year ago

1.4.41

1 year ago

1.4.40

1 year ago

1.4.39

1 year ago

1.4.38

1 year ago

1.4.37

1 year ago

1.4.36

1 year ago

1.4.35

1 year ago

1.4.34

1 year ago

1.4.33

1 year ago

1.4.32

1 year ago

1.4.31

1 year ago

1.4.30

1 year ago

1.4.29

1 year ago

1.3.29

1 year ago

1.3.28

1 year ago

1.3.27

1 year ago

1.2.27

1 year ago

1.2.26

1 year ago

1.2.25

1 year ago

1.2.24

1 year ago

1.2.23

1 year ago

1.2.22

1 year ago

1.2.21

1 year ago

1.2.20

1 year ago

1.2.19

1 year ago

1.2.18

1 year ago

1.2.17

1 year ago

1.1.17

1 year ago

1.1.16

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