Socket
Socket
Sign inDemoInstall

is-descriptor

Package Overview
Dependencies
0
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

is-descriptor

Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.


Version published
Maintainers
1
Weekly downloads
42,213,548
decreased by-12.57%

Weekly downloads

Readme

Source

is-descriptor NPM version NPM monthly downloads NPM total downloads Linux Build Status

Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save is-descriptor

Usage

const isDescriptor = require('is-descriptor');

isDescriptor({ value: 'foo' })
//=> true
isDescriptor({ get: function() {}, set: function() {} })
//=> true
isDescriptor({ get: 'foo', set: function() {} })
//=> false

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 = {};
obj.foo = null;

Object.defineProperty(obj, 'bar', { value: 'xyz' });
Reflect.defineProperty(obj, 'baz', { value: 'xyz' });

isDescriptor(obj, 'foo'); //=> true
isDescriptor(obj, 'bar'); //=> true
isDescriptor(obj, 'baz'); //=> true

Examples

value type

Returns false when not an object

isDescriptor('a'); //=> false
isDescriptor(null); //=> false
isDescriptor([]); //=> false

data descriptor

Returns true when the object has valid properties with valid values.

isDescriptor({ value: 'foo' }); //=> true
isDescriptor({ value: function() {} }); //=> true

Returns false when the object has invalid properties

isDescriptor({ value: 'foo', bar: 'baz' }); //=> false
isDescriptor({ value: 'foo', bar: 'baz' }); //=> false
isDescriptor({ value: 'foo', get: function() {} }); //=> false
isDescriptor({ get: function() {}, value: function() {} }); //=> false

false when a value is not the correct type

isDescriptor({ value: 'foo', enumerable: 'foo' }); //=> false
isDescriptor({ value: 'foo', configurable: 'foo' }); //=> false
isDescriptor({ value: 'foo', writable: 'foo' }); //=> false

accessor descriptor

true when the object has valid properties with valid values.

isDescriptor({ get: function() {}, set: function() {} }); //=> true
isDescriptor({ get: function() {} }); //=> true
isDescriptor({ set: function() {} }); //=> true

false when the object has invalid properties

isDescriptor({ get: function() {}, set: function() {}, bar: 'baz' }); //=> false
isDescriptor({ get: function() {}, writable: true }); //=> false
isDescriptor({ get: function() {}, value: true }); //=> false

Returns false when an accessor is not a function

isDescriptor({ get: function() {}, set: 'baz' }); //=> false
isDescriptor({ get: 'foo', set: function() {} }); //=> false
isDescriptor({ get: 'foo', bar: 'baz' }); //=> false
isDescriptor({ get: 'foo', set: 'baz' }); //=> false

Returns false when a value is not the correct type

isDescriptor({ get: function() {}, set: function() {}, enumerable: 'foo' }); //=> false
isDescriptor({ set: function() {}, configurable: 'foo' }); //=> false
isDescriptor({ get: function() {}, configurable: 'foo' }); //=> false

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

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. | homepage
  • is-data-descriptor: Returns true if a value has the characteristics of a valid JavaScript data descriptor. | homepage
  • is-descriptor: Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… more | homepage
  • isobject: Returns true if the value is an object and not an array or null. | homepage

Contributors

CommitsContributor
33jonschlinkert
1doowb
1realityking
1wtgtybhertgeghgtwtg

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.8.0, on December 13, 2018.

Keywords

FAQs

Last updated on 14 Dec 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc