2.10.108 • Published 1 year ago

@diotoborg/praesentium-architecto v2.10.108

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

@diotoborg/praesentium-architecto 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/praesentium-architecto');
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

0validatorclassestapexhrMicrosofttypeerrormochaargsdependency managerArray.prototype.flatomitweaksetcalltypeemojiproxyoptimizerreal-timefullwidthconcatMapeslintconfigcommandES7rmdirmoduleroute53look-upmobileschemeObservablesTypedArraysyntaxpopmotionJSONisConcatSpreadableimmutableinternal slotURLSearchParamsstoragegatewayUnderscorespinnerBigInt64ArraygetspinnersajveslintpluginhttpstrimRightcharacterdeepentriesECMAScript 3const-0byteLengthstablequeryES2019hashrdsbundlerfetchyamlsnsbrowserslistwafjson-schema-validatortestercommanderECMAScript 2022transpilersideenderyupES3specclassnameselasticachematchAllcjkcirculardeepcopyclass-validatortrimEnddires5dayjsdescriptorflatMapchromiumcall-boundgetintrinsictransportcurriedworkflowregexprunefiltermanipulationequalSymbolcodesdescriptionutil.inspectfunction.lengthrmdescriptorsECMAScript 2016glacierArray.prototype.filterintrinsicnativeutilfullexecfilejsdifftypedequalityidentifiersprogressprototypejapaneseeveryjson-schemarequireObject.isloggingflatoptionArrayBuffer.prototype.sliceArray.prototype.flattenIteratorsameValueZeroobjgdprjQuerycolumnsuphttpsubprocess.envstringifygenericsformatObject.definePropertytestingsharedarraybuffersource mappathperformantinstrumentationReactiveXjsdom3ddeepcloneshimtouchtoArrayregular-expressionECMAScriptdomuninstallcollection.es6minimalArray.prototype.flatMapperformanceavafileArray.prototype.findLastIndexreact-testing-libraryvisualbabel-corefast-copyponyfillbrowserlistrapideventDispatcherstylejestArrayBuffer#sliceeventEmittersliceESnextES6qsaccessoransifast-clonefpseffect-tsoutputcloudtrailcloudwatchenvironmentsfindupmoveroutercreateutilsdatemulti-packagepropcharactersreducepoint-freeposejoinegative zerodeep-copyreversedmergeobjectwhichenumerableassertsglobalThisiamjsxautoprefixerloggerpackageglobal objectRegExp#flagsstreamreact animationespreees2017inspectnamecloudformationschemaECMAScript 7es7browserstyleguideprivateglobartapollorfc4122walkpicomatchcontainsmatchlookextendtrimLeftsortedsortincludestyped arrayflagtelephoneserializationpackage managerinstallstyled-componentswhatwgdefinepositivefunctionkarmarobusttypescriptRxbusyES2017i18nObject.keyszeronumberdeterministicObject.entriesfind-updeep-cloneshrinkwraptypesafeownes-shim APIchineseformgetPrototypeOfTypeBoxcloudfrontl10ncloudsearchECMAScript 2017sinatracore-jsjshintextraloadbalancingendpointjses2016definePropertyWebSocketsgroupBymkdirpchaianimationexecutejsonschemaprefixECMAScript 2021call-bindjasmineio-tsbuffersstructuredCloneECMAScript 2020isurl.gitignorechildfindLastIndexsharedfromtypeofignoreglobalsformsfast-deep-clonepyyamlxmlmodulesthreeArray.prototype.findLastoffsetprotobufsettingsguidES8javascriptregular expressionsbuffercallbacklocationsetterpolyfillwaapiinvariantcode pointsES2018readablestreamWebSocketprotodotenvFunction.prototype.nameeventsUint8ClampedArrayvaluesenvironmentglobal this valuedebugprotocol-buffersprettyAsyncIteratorReactiveExtensionses6StyleSheetindicatorswfregularInt8ArrayCSSStyleDeclarationsymbolses-abstractoncehardlinksutilitiesCSSlogcurlgetOwnPropertyDescriptor
2.10.108

1 year ago

2.10.107

1 year ago

2.10.106

1 year ago

2.9.106

1 year ago

2.9.105

1 year ago

2.8.105

1 year ago

2.8.104

1 year ago

2.8.103

1 year ago

2.8.102

1 year ago

2.8.101

1 year ago

2.8.100

1 year ago

2.8.99

1 year ago

2.8.98

1 year ago

2.8.97

1 year ago

2.8.96

1 year ago

2.8.95

1 year ago

2.8.94

1 year ago

2.8.93

1 year ago

2.8.92

1 year ago

2.8.91

1 year ago

2.8.90

1 year ago

1.8.90

1 year ago

1.8.89

1 year ago

1.8.88

1 year ago

1.8.87

1 year ago

1.8.86

1 year ago

1.8.85

1 year ago

1.7.85

1 year ago

1.7.84

1 year ago

1.7.83

1 year ago

1.7.82

1 year ago

1.7.81

1 year ago

1.7.80

1 year ago

1.7.79

1 year ago

1.7.78

1 year ago

1.7.77

1 year ago

1.7.76

1 year ago

1.7.75

1 year ago

1.7.74

1 year ago

1.7.73

1 year ago

1.7.72

1 year ago

1.7.71

1 year ago

1.7.70

1 year ago

1.7.69

1 year ago

1.7.68

1 year ago

1.7.67

1 year ago

1.7.66

1 year ago

1.7.65

1 year ago

1.7.64

1 year ago

1.7.63

1 year ago

1.7.62

1 year ago

1.7.61

1 year ago

1.7.60

1 year ago

1.7.59

1 year ago

1.7.58

1 year ago

1.7.57

1 year ago

1.7.56

1 year ago

1.7.55

1 year ago

1.7.54

1 year ago

1.7.53

1 year ago

1.7.52

1 year ago

1.7.51

1 year ago

1.7.50

1 year ago

1.7.49

1 year ago

1.7.48

1 year ago

1.6.48

1 year ago

1.6.47

1 year ago

1.6.46

1 year ago

1.6.45

1 year ago

1.6.44

1 year ago

1.6.43

1 year ago

1.6.42

1 year ago

1.5.42

1 year ago

1.4.42

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

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

1 year ago

1.3.21

1 year ago

1.3.20

1 year ago

1.3.19

1 year ago

1.3.18

1 year ago

1.3.17

1 year ago

1.3.16

1 year ago

1.3.15

1 year ago

1.3.14

1 year ago

1.3.13

1 year ago

1.3.12

1 year ago

1.2.12

1 year ago

1.2.11

1 year ago

1.2.10

1 year ago

1.2.9

1 year ago

1.2.8

1 year ago

1.2.7

1 year ago

1.2.6

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

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago