5.4.101 • Published 10 months ago

@diotoborg/eveniet-pariatur-esse v5.4.101

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

@diotoborg/eveniet-pariatur-esse 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/eveniet-pariatur-esse');
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

transportstylemovereplaydatees2018exitpolyfillmacosgetInt16Arrayzodcss variablelintrequirejson-schema-validatormrucommand-lineESexectoSortedjsxInt8Arraytelephonefunctionidentifierscheckfast-deep-clonequerystatelessUint8Arraytextshimnamebootstrap lesshelperinferencetranspileraccessibilityconfigurableYAMLenvironmentSetshellwhatwgi18nmomentless mixinsES3errormatchspeedArray.prototype.flattenutilityRegExp.prototype.flagsinputjshintautoprefixertranspilenegativetoReversedcircularharmonyESnextarktypees-shimsHyBisortedpruneString.prototype.trimobjectstylesheetshebangcall-boundproxyphonenpmignorecommanderrandomboundvpcglobalsObject.valuesUint8ClampedArrayglobal this valuebinariescall-bindbinaryownpluginmodulesvariterationsliceframeresmapreduceArray.prototype.findLastjsonschemafindgroup$.extendwindowscloudtrailfnmatchES5onceInt32Arraycensorredactdatapoint-freeminimalreadcollectionquoteponyfillomitfastifyinstallreducereverseloadbalancingparsingObject.getPrototypeOfdotenvfpsroute53endpointqueueMicrotaskescapeargsreal-timeuser-streamsmulti-packageresolvefigletmakeelmtesterdefinePropertyextracloneiekinesisfast-cloneexecfilestylesidleinternal slothelpersArray.prototype.flatchineseArrayBuffer.prototype.sliceglobalsettingsemitfastclonedynamodbruntimewritablechanneles-shim APIelectroneventsautoscalinglrucssprivateamazonconcatMaploggerhigher-orderes2017banneruploadreact-hookstostringtaghardlinksless compileriteratorpassworditeraterangeerrorhooksnodeObject.iseventEmitteroperating-systemmetadatabeanstalkECMAScript 2023bootstrap cssdeepsharedarraybufferdragspinnersprotoignorepicomatchenvregexbrowserlistnested cssstringequalcallbackhasestreeES8gdprflagsstreamasttypespostcss-pluginauthArray.prototype.flatMapcloudsearchdescriptionapollographqlfantasy-landrecursivecharacterreact-componentpnpm9cloudwatchsortelasticachestringifierwhichjson-schema-validationcolorscreateeslintpluginECMAScript 2016curlES2015gradients cssString.prototype.matchAlldatastructurewafzerobyteOffsetTypedArraypositivesomerapidwarninghandlersoptimizerbcryptchaicontainsl10ngroupByECMAScript 7typedarrayshookforminspectstyleguideramdaqueuemixinsES2016functionalobjReactiveExtensionstermpopmotionsetPrototypeOfyuptypesafextermsescss-in-jsObject.fromEntriestddES2023getintrinsicform-validationtrimStartreusevisualeverysymlinkoptionECMAScript 2015forEachlistenerspackage managerasciiconcatcompile lessReflect.getPrototypeOftypeeast-asian-widthterminalObject.entriesenumerableregular-expressionindicatorlazyFunction.prototype.namecopyPushwidthreacttsnativepropertiesgetPrototypeOfvariables in csshttpslinuxSymbolutilitiesUint32Arrayinterruptstestingcore-jsassertgitignoretoStringTag__proto__es7wgetreact-hook-formfindLastIndexliveprotocol-buffersjsondependency managermkdirsimportexportAsyncIterator@@toStringTagpushcomparees2016shamwaitformatWeakSetbinSystem.globalregular expressionpostcssmkdirvalueacornscheme-validationFloat64ArrayES2017outputglobal objectjsdomguidassignanimationsymlinksgetopttypeofclientec2xhrObservablesconsumeschemaRxJSsnsreact poseisConcatSpreadableremoveURLSearchParamsstablePromiseirqviewpromiseairbnbbusyvalidationWebSocketdeepcloneES2018gradients css3consolepreserve-symlinksdescriptorsameValueZerotc39error-handlingserializationES2019browserslistfpmatchesyamlReactiveXflagsetterfrom256workerhasOwn
5.4.100

10 months ago

5.4.101

10 months ago

5.4.99

10 months ago

5.4.98

10 months ago

4.4.98

10 months ago

4.4.97

10 months ago

4.4.96

10 months ago

4.4.95

10 months ago

4.4.94

10 months ago

4.4.93

10 months ago

4.4.92

10 months ago

4.4.91

10 months ago

4.3.91

10 months ago

4.3.90

10 months ago

4.3.89

10 months ago

3.3.89

10 months ago

3.3.88

10 months ago

3.3.87

10 months ago

3.3.86

10 months ago

3.3.85

10 months ago

3.3.84

10 months ago

3.3.83

10 months ago

3.3.82

11 months ago

3.3.81

11 months ago

3.3.80

11 months ago

3.3.79

11 months ago

3.3.78

11 months ago

3.3.77

11 months ago

3.3.76

11 months ago

3.3.75

11 months ago

3.3.74

11 months ago

3.3.73

11 months ago

2.3.73

11 months ago

2.3.72

11 months ago

2.3.71

11 months ago

2.3.70

11 months ago

2.2.70

11 months ago

2.2.69

11 months ago

2.2.68

11 months ago

2.2.67

11 months ago

2.2.66

11 months ago

2.2.65

11 months ago

2.2.64

11 months ago

2.2.63

11 months ago

2.2.62

11 months ago

2.2.61

11 months ago

2.2.60

11 months ago

2.2.59

11 months ago

2.2.58

11 months ago

2.2.57

11 months ago

2.2.56

11 months ago

2.2.55

11 months ago

2.2.54

12 months ago

2.2.53

12 months ago

2.2.52

12 months ago

2.2.51

12 months ago

2.2.50

12 months ago

2.1.50

12 months ago

2.1.49

12 months ago

2.1.48

12 months ago

2.1.47

12 months ago

2.1.46

12 months ago

2.1.45

12 months ago

2.1.44

12 months ago

2.1.43

12 months ago

2.1.42

12 months ago

2.1.41

12 months ago

2.1.40

12 months ago

2.1.39

12 months ago

2.0.39

12 months ago

2.0.38

12 months ago

2.0.37

12 months ago

2.0.36

1 year ago

2.0.35

1 year ago

2.0.34

1 year ago

2.0.33

1 year ago

2.0.32

1 year ago

2.0.31

1 year ago

2.0.30

1 year ago

2.0.29

1 year ago

2.0.28

1 year ago

2.0.27

1 year ago

2.0.26

1 year ago

2.0.25

1 year ago

1.0.25

1 year ago

1.0.24

1 year ago

1.0.23

1 year ago

1.0.22

1 year ago

1.0.21

1 year ago

1.0.20

1 year ago

1.0.19

1 year ago

1.0.18

1 year ago

1.0.17

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