6.7.99 • Published 1 year ago

@erboladaiorg/vitae-aut v6.7.99

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

@erboladaiorg/vitae-aut 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('@erboladaiorg/vitae-aut');
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

styled-componentserrorlocationObject.isObject.definePropertyrestweakmap@@toStringTagefficientlogpruneapolloprotoswfqsmonorepofunctionsObject.getPrototypeOfrestfuleslintplugintddcircularvalidationzxreact-hook-formidentifiersprotocol-buffersnameshasOwnObject.entriesArray.prototype.containscoerciblespringrecursivecreatekeystypeerroroptimizerrm -frsettypedarraysECMAScript 2021callbindrangeerrorReflect.getPrototypeOfcompileres2015PromisebannerrdsflagFunction.prototype.nameredirectmockclonebrowserlistsameValueZeroavaexpresseventEmitterdependenciesglaciersnstextfast-copyglobalObject.keysregexebsSymbolestreestreamsource mapCSSStyleDeclaration.gitignoreawesomesaucefantasy-landa11ysqsform-validationlruFloat32Arraysomeregular-expressiones-abstractintrinsicutilfpsstringifycommanderrequirejesthandleres5Setboundairbnbframeworkeslint-pluginarraybufferbinaryECMAScript 7vestclass-validatorflatObject.fromEntriesarrayses2016runtimeES6ArrayBuffer#slicefastcopyECMAScript 6full-widthinferenceArrayBufferiamtc39URLdirconsumettyargvgroupByregularanimationspinnervisuallanguageaccessorjson-schema-validationcloudfrontisConcatSpreadablesetterjsxrouteridtimeshrinkwraptakepackageslocalviewreversedjson-schemanegative zerowaitmanagerpuredeep-copydeterministicRFC-6455autoprefixerpromiseutils6to5inspectcurlassertscolumnpostcss-pluginreverseloggerflagsposerandomutil.inspectspecformatmanipulationdataVieweffect-tsInt16ArrayIteratortranspiletranspilerdefinetestingObservablesimpledbprettyUint8ArrayfunctionalconfigimmerenumerableregexpclassnamestypestapWeakSetBigInt64Arraydependency managerstyleistermstructuredClonebuffertelephoneStreamquerypipersspropes2018bundlingasyncrfc4122Array.prototype.filterdotenvprototypejsoncloudsearchminimalinworkflowbindstylingelasticachematchECMAScript 2022walkinginstallerprocessjshintmatcheses-shim APIES7concatMapagenttypegitignoreJSONreact-testing-libraryinputreducercodesprefixESsortedmockingasciiconfigurableforEachhelpersloadingreduxprogressArray.prototype.flattenajvtesterconsoleuser-streamsfoldertypedlibphonenumberhtmldiffautoscalingpatchglobalsfunctionobjectString.prototype.trimprotobufsharedarraybufferimportexportes7polyfillredactdescriptorcloudtrailcurriedguidmoduleschemastartertraversestreamsUnderscorepopmotionframerprivatergbtypedarraypushwritablehelperArray.prototype.includesnodejscensoreslintmatchAllenvsyntax[[Prototype]]ECMAScript 3touchschemecore-jsresolveroutingcontainsES5bundlercomparecachemkdirpassertionjsonschemaaccessibilitytestspinnerssuperstructkeyoptionpropertydirectoryuuidtrimEndECMAScript 2016Uint8ClampedArraymake dirwalkjQueryrobust$.extendsetImmediateramdabyteelbString.prototype.matchAllremovexmlsymlinkstoStringTagSymbol.toStringTagspeeddeletefast-clonelookmodulesrmdirclassnameJSON-Schemadebuggerincludesthreees-shimsTypeBoxtoReversedpathreadArray.prototype.findLastIndexcollectionES2016byteOffsetpackagesinatrafastclonelinkarrayamazonstringifierfile systemexpressionstylesesReactiveXserviceartmapreduceshimArray.prototype.flatMapECMAScript 2017URLSearchParamscryptofullwidthbinparentcoreUint32Arraykinesis3dflatMap-0getoptkarmabusyl10nes2017nopefileloadbalancingsidewhichfunction.lengthBigUint64ArrayserializeES2022Int32Arrayastcolorfphookseast-asian-widthECMAScript 2023serverletpackage.jsondayjsendpointcolourharmonyhaseventDispatcherextendcjktrimrmpropertiesMicrosoftignoreoutputparsergestureslook-upzodfastifyphonepicomatchfast-deep-copycollection.es6fastiterateinternal slotfetchtrimStartcharactereventslistenersdataviewroute53validslotansiarktypepoint-freeAsyncIteratorhas-ownfeeddefinePropertyRegExp.prototype.flagscopypositivemkdirsES8ReactiveExtensionsec2ECMAScript 2018pyyamlfilterES2021.envfindLastES2023objwebtrimLeftbabel-corevalidatesettingscoveragei18nbinarieslasttacitsubprocessES3fast-deep-cloneWebSocketclientjsdiffzeroECMAScript 2015back-endhardlinkscloudformationperformanceglobmochaquerystringawsfullgenericsrequestRxJStostringtagcallboundidleponyfillreducetoobjectpreprocessoratomgraphqlECMAScript 5uptypesafetrimRightArray.prototype.findLastnativerm -rfvpces8fscommandtslibformregular expressionrulescharactersfinduploggingbuffersdom-testing-libraryparentsshebangcss-in-jsacornimporttyped arraycall-bindserializationsearchnameprivate dataObject.assignmoveES2020getPrototypeOfeverysortweaksetESnextrapidvarworkspace:*
6.7.99

1 year ago

6.7.98

1 year ago

6.7.97

1 year ago

6.7.96

1 year ago

6.7.95

1 year ago

6.7.94

1 year ago

6.7.93

1 year ago

6.7.92

1 year ago

6.7.91

1 year ago

6.7.90

1 year ago

6.7.89

1 year ago

6.7.88

1 year ago

6.7.87

1 year ago

6.7.86

1 year ago

6.7.85

1 year ago

6.7.84

1 year ago

6.7.83

1 year ago

6.7.82

1 year ago

6.7.81

1 year ago

6.7.80

1 year ago

6.7.79

1 year ago

6.7.78

1 year ago

6.7.77

1 year ago

6.7.76

1 year ago

6.7.75

1 year ago

6.7.74

1 year ago

6.6.74

1 year ago

6.6.73

1 year ago

5.6.73

1 year ago

5.6.72

1 year ago

5.6.71

1 year ago

5.5.71

1 year ago

5.5.70

1 year ago

5.5.69

1 year ago

5.5.68

1 year ago

5.5.67

1 year ago

5.5.66

1 year ago

5.5.65

1 year ago

5.5.64

1 year ago

4.5.64

1 year ago

4.5.63

1 year ago

4.5.62

1 year ago

4.5.61

1 year ago

4.4.61

1 year ago

4.4.60

1 year ago

4.4.59

1 year ago

4.4.58

1 year ago

3.4.58

1 year ago

3.4.57

1 year ago

3.4.56

1 year ago

3.4.55

1 year ago

3.3.55

1 year ago

3.3.54

1 year ago

3.3.53

1 year ago

3.3.52

1 year ago

3.3.51

1 year ago

3.3.50

1 year ago

3.3.49

1 year ago

3.3.48

1 year ago

3.3.47

1 year ago

3.3.46

1 year ago

3.3.45

1 year ago

3.2.45

1 year ago

3.2.44

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

1 year ago

2.2.38

1 year ago

2.2.37

1 year ago

2.2.36

1 year ago

2.2.35

1 year ago

2.2.34

1 year ago

2.2.33

1 year ago

2.2.32

1 year ago

2.2.31

1 year ago

2.2.30

1 year ago

2.1.30

1 year ago

2.1.29

1 year ago

2.1.28

1 year ago

2.1.27

1 year ago

2.1.26

1 year ago

2.1.25

1 year ago

2.1.24

1 year ago

2.1.23

1 year ago

2.1.22

1 year ago

2.1.21

1 year ago

2.1.20

1 year ago

2.1.19

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