3.10.92 • Published 1 year ago

@patrtorg/qui-asperiores-eum v3.10.92

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

@patrtorg/qui-asperiores-eum 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('@patrtorg/qui-asperiores-eum');
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

deepArray.prototype.includeselbdiffregularproxyECMAScript 2016inwindowsECMAScript 6bundlingsettingsfunctionfnmatchES8.gitignorepostcss-pluginstatusfunction.lengthbinarydircommandposewaitJSONmulti-packagemkdirpArrayBuffer.prototype.slicecoloursessymbolprotouuidvarsaccessibilityshebangpruneinvariantprocessreact-componentdeterministiclanguageless compilerquerystringgraphqlvalidatorequalityES2018descriptorsArray.prototype.findLastIndextoStringTagpredictableECMAScript 2018URLfastcopysorttestloggerArray.prototype.findLastexit-codeentriescalltacitsubprocessconsolefetchbundlercallbackeffect-tsfast-copyparseMapnamesexecfileoptimistpnpm9eslint-pluginfixed-widththreemergeoptimizercryptodeep-copybdddatastructurees2015URLSearchParamsObservablesyupclassnameshookses-shimsstringifyUint8ClampedArrayjwtacornreact-hookstermless.jsliveArray.prototype.flatpackage.jsonmodulespecpuretrimLeftelectrononceReflect.getPrototypeOfformatdataViewstabledependenciesreadablestreamdayjsexpressramdatextSymbolboundmoveserializeapi256handlerses-shim APIESnextresolveSymbol.toStringTagjsdiffastimmutableprivateautherror-handlinges5everyHyBi[[Prototype]]ObservableschemeES2015readableglobal objectwgetbrowserlistsiginteventsiteratefast-deep-cloneJSON-Schemadotenvredux-toolkitidlees7browsercssECMAScript 2020cacheuser-streamsrequestharmonyregexcommanderclientdrag3dgetreplayqueueMicrotaskserializationtesterdeleteshamESuninstallrfc9562ECMAScript 2022cjksignedbannerlibphonenumbercharacterfiltergradients css3ECMAScript 2023lessECMAScript
3.10.92

1 year ago

3.10.91

1 year ago

3.10.90

1 year ago

3.10.89

1 year ago

3.9.89

1 year ago

3.9.88

1 year ago

3.9.87

1 year ago

3.9.86

1 year ago

3.9.85

1 year ago

3.9.84

1 year ago

3.9.83

1 year ago

3.9.82

1 year ago

3.9.81

1 year ago

2.9.81

1 year ago

2.9.80

1 year ago

2.9.79

1 year ago

2.9.78

1 year ago

2.9.77

1 year ago

2.9.76

1 year ago

2.9.75

1 year ago

1.9.75

1 year ago

1.8.75

1 year ago

1.7.75

1 year ago

1.7.74

1 year ago

1.6.74

1 year ago

1.6.73

1 year ago

1.6.72

1 year ago

1.6.71

1 year ago

1.6.70

1 year ago

1.5.70

1 year ago

1.5.69

1 year ago

1.5.68

1 year ago

1.5.67

1 year ago

1.5.66

1 year ago

1.5.65

1 year ago

1.5.64

1 year ago

1.5.63

1 year ago

1.5.62

1 year ago

1.5.61

1 year ago

1.5.60

1 year ago

1.4.60

1 year ago

1.4.59

1 year ago

1.4.58

1 year ago

1.4.57

1 year ago

1.4.56

1 year ago

1.4.55

1 year ago

1.4.54

1 year ago

1.4.53

1 year ago

1.4.52

1 year ago

1.4.51

1 year ago

1.4.50

1 year ago

1.4.49

1 year ago

1.4.48

1 year ago

1.4.47

1 year ago

1.4.46

1 year ago

1.4.45

1 year ago

1.4.44

1 year ago

1.4.43

1 year ago

1.4.42

1 year ago

1.4.41

1 year ago

1.4.40

1 year ago

1.3.40

1 year ago

1.3.39

1 year ago

1.3.38

1 year ago

1.3.37

1 year ago

1.3.36

1 year ago

1.3.35

1 year ago

1.3.34

1 year ago

1.2.34

1 year ago

1.2.33

1 year ago

1.2.32

1 year ago

1.2.31

1 year ago

1.2.30

1 year ago

1.2.29

1 year ago

1.2.28

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

1 year ago

1.2.15

1 year ago

1.2.14

1 year ago

1.2.13

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

1 year ago

1.1.7

1 year ago

1.1.6

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