pax_global_header00006660000000000000000000000064134046263530014520gustar00rootroot0000000000000052 comment=c46560a525edd9c338556936254d4f0cbd3871c7 is-descriptor-3.0.0/000077500000000000000000000000001340462635300143075ustar00rootroot00000000000000is-descriptor-3.0.0/.editorconfig000066400000000000000000000003271340462635300167660ustar00rootroot00000000000000# http://editorconfig.org/ root = true [*] charset = utf-8 end_of_line = lf indent_size = 2 indent_style = space insert_final_newline = true trim_trailing_whitespace = true [*.md] trim_trailing_whitespace = false is-descriptor-3.0.0/.eslintrc.json000066400000000000000000000073251340462635300171120ustar00rootroot00000000000000{ "extends": [ "eslint:recommended" ], "env": { "browser": false, "es6": true, "node": true, "mocha": true }, "parserOptions":{ "ecmaVersion": 9, "sourceType": "module", "ecmaFeatures": { "modules": true, "experimentalObjectRestSpread": true } }, "globals": { "document": false, "navigator": false, "window": false }, "rules": { "accessor-pairs": 2, "arrow-spacing": [2, { "before": true, "after": true }], "block-spacing": [2, "always"], "brace-style": [2, "1tbs", { "allowSingleLine": true }], "comma-dangle": [2, "never"], "comma-spacing": [2, { "before": false, "after": true }], "comma-style": [2, "last"], "constructor-super": 2, "curly": [2, "multi-line"], "dot-location": [2, "property"], "eol-last": 2, "eqeqeq": [2, "allow-null"], "generator-star-spacing": [2, { "before": true, "after": true }], "handle-callback-err": [2, "^(err|error)$" ], "indent": [2, 2, { "SwitchCase": 1 }], "key-spacing": [2, { "beforeColon": false, "afterColon": true }], "keyword-spacing": [2, { "before": true, "after": true }], "new-cap": [2, { "newIsCap": true, "capIsNew": false }], "new-parens": 2, "no-array-constructor": 2, "no-caller": 2, "no-class-assign": 2, "no-cond-assign": 2, "no-const-assign": 2, "no-control-regex": 2, "no-debugger": 2, "no-delete-var": 2, "no-dupe-args": 2, "no-dupe-class-members": 2, "no-dupe-keys": 2, "no-duplicate-case": 2, "no-empty-character-class": 2, "no-eval": 2, "no-ex-assign": 2, "no-extend-native": 2, "no-extra-bind": 2, "no-extra-boolean-cast": 2, "no-extra-parens": [2, "functions"], "no-fallthrough": 2, "no-floating-decimal": 2, "no-func-assign": 2, "no-implied-eval": 2, "no-inner-declarations": [2, "functions"], "no-invalid-regexp": 2, "no-irregular-whitespace": 2, "no-iterator": 2, "no-label-var": 2, "no-labels": 2, "no-lone-blocks": 2, "no-mixed-spaces-and-tabs": 2, "no-multi-spaces": 2, "no-multi-str": 2, "no-multiple-empty-lines": [2, { "max": 1 }], "no-native-reassign": 0, "no-negated-in-lhs": 2, "no-new": 2, "no-new-func": 2, "no-new-object": 2, "no-new-require": 2, "no-new-wrappers": 2, "no-obj-calls": 2, "no-octal": 2, "no-octal-escape": 2, "no-proto": 0, "no-redeclare": 2, "no-regex-spaces": 2, "no-return-assign": 2, "no-self-compare": 2, "no-sequences": 2, "no-shadow-restricted-names": 2, "no-spaced-func": 2, "no-sparse-arrays": 2, "no-this-before-super": 2, "no-throw-literal": 2, "no-trailing-spaces": 0, "no-undef": 2, "no-undef-init": 2, "no-unexpected-multiline": 2, "no-unneeded-ternary": [2, { "defaultAssignment": false }], "no-unreachable": 2, "no-unused-vars": [2, { "vars": "all", "args": "none" }], "no-useless-call": 0, "no-with": 2, "one-var": [0, { "initialized": "never" }], "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], "padded-blocks": [0, "never"], "quotes": [2, "single", "avoid-escape"], "radix": 2, "semi": [2, "always"], "semi-spacing": [2, { "before": false, "after": true }], "space-before-blocks": [2, "always"], "space-before-function-paren": [2, "never"], "space-in-parens": [2, "never"], "space-infix-ops": 2, "space-unary-ops": [2, { "words": true, "nonwords": false }], "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], "use-isnan": 2, "valid-typeof": 2, "wrap-iife": [2, "any"], "yoda": [2, "never"] } } is-descriptor-3.0.0/.gitattributes000066400000000000000000000002001340462635300171720ustar00rootroot00000000000000# Enforce Unix newlines * text eol=lf # binaries *.ai binary *.psd binary *.jpg binary *.gif binary *.png binary *.jpeg binary is-descriptor-3.0.0/.gitignore000066400000000000000000000004561340462635300163040ustar00rootroot00000000000000# always ignore files *.DS_Store .idea .vscode *.sublime-* # test related, or directories generated by tests test/actual actual coverage .nyc* # npm node_modules npm-debug.log # yarn yarn.lock yarn-error.log # misc _gh_pages _draft _drafts bower_components vendor temp tmp TODO.md package-lock.jsonis-descriptor-3.0.0/.npmrc000066400000000000000000000000231340462635300154220ustar00rootroot00000000000000package-lock=false is-descriptor-3.0.0/.travis.yml000066400000000000000000000002041340462635300164140ustar00rootroot00000000000000sudo: false os: - linux - osx - windows language: node_js node_js: - node - '11' - '10' - '9' - '8' - '7' - '6' is-descriptor-3.0.0/.verb.md000066400000000000000000000051421340462635300156470ustar00rootroot00000000000000## Usage ```js const isDescriptor = require('{%= name %}'); 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. ```js 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 ```js isDescriptor('a'); //=> false isDescriptor(null); //=> false isDescriptor([]); //=> false ``` ### data descriptor Returns `true` when the object has valid properties with valid values. ```js isDescriptor({ value: 'foo' }); //=> true isDescriptor({ value: function() {} }); //=> true ``` Returns `false` when the object has invalid properties ```js 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 ```js 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. ```js isDescriptor({ get: function() {}, set: function() {} }); //=> true isDescriptor({ get: function() {} }); //=> true isDescriptor({ set: function() {} }); //=> true ``` `false` when the object has invalid properties ```js 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 ```js 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 ```js isDescriptor({ get: function() {}, set: function() {}, enumerable: 'foo' }); //=> false isDescriptor({ set: function() {}, configurable: 'foo' }); //=> false isDescriptor({ get: function() {}, configurable: 'foo' }); //=> false ``` is-descriptor-3.0.0/LICENSE000066400000000000000000000021031340462635300153100ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2015-present, Jon Schlinkert. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. is-descriptor-3.0.0/README.md000066400000000000000000000150311340462635300155660ustar00rootroot00000000000000# is-descriptor [![NPM version](https://img.shields.io/npm/v/is-descriptor.svg?style=flat)](https://www.npmjs.com/package/is-descriptor) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-descriptor.svg?style=flat)](https://npmjs.org/package/is-descriptor) [![NPM total downloads](https://img.shields.io/npm/dt/is-descriptor.svg?style=flat)](https://npmjs.org/package/is-descriptor) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-descriptor.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-descriptor) > 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](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save is-descriptor ``` ## Usage ```js 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. ```js 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 ```js isDescriptor('a'); //=> false isDescriptor(null); //=> false isDescriptor([]); //=> false ``` ### data descriptor Returns `true` when the object has valid properties with valid values. ```js isDescriptor({ value: 'foo' }); //=> true isDescriptor({ value: function() {} }); //=> true ``` Returns `false` when the object has invalid properties ```js 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 ```js 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. ```js isDescriptor({ get: function() {}, set: function() {} }); //=> true isDescriptor({ get: function() {} }); //=> true isDescriptor({ set: function() {} }); //=> true ``` `false` when the object has invalid properties ```js 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 ```js 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 ```js 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](../../issues/new).
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: ```sh $ npm install && npm test ```
Building docs _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ```
### Related projects You might also be interested in these projects: * [is-accessor-descriptor](https://www.npmjs.com/package/is-accessor-descriptor): Returns true if a value has the characteristics of a valid JavaScript accessor descriptor. | [homepage](https://github.com/jonschlinkert/is-accessor-descriptor "Returns true if a value has the characteristics of a valid JavaScript accessor descriptor.") * [is-data-descriptor](https://www.npmjs.com/package/is-data-descriptor): Returns true if a value has the characteristics of a valid JavaScript data descriptor. | [homepage](https://github.com/jonschlinkert/is-data-descriptor "Returns true if a value has the characteristics of a valid JavaScript data descriptor.") * [is-descriptor](https://www.npmjs.com/package/is-descriptor): Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for… [more](https://github.com/jonschlinkert/is-descriptor) | [homepage](https://github.com/jonschlinkert/is-descriptor "Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.") * [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject "Returns true if the value is an object and not an array or null.") ### Contributors | **Commits** | **Contributor** | | --- | --- | | 33 | [jonschlinkert](https://github.com/jonschlinkert) | | 1 | [doowb](https://github.com/doowb) | | 1 | [realityking](https://github.com/realityking) | | 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | ### Author **Jon Schlinkert** * [GitHub Profile](https://github.com/jonschlinkert) * [Twitter Profile](https://twitter.com/jonschlinkert) * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) ### License Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on December 13, 2018._is-descriptor-3.0.0/index.js000066400000000000000000000022101340462635300157470ustar00rootroot00000000000000'use strict'; const isObject = val => val !== null && typeof val === 'object'; const dataDesc = new Set(['configurable', 'enumerable', 'get', 'set']); const accDesc = new Set(['configurable', 'enumerable', 'writable', 'value']); module.exports = (obj, key, checkProto) => { if (!isObject(obj)) return false; let desc = key ? Object.getOwnPropertyDescriptor(obj, key) : obj; if (!desc && key && checkProto !== false && obj.constructor) { desc = Object.getOwnPropertyDescriptor(obj.constructor.prototype, key); } if (!isObject(desc)) return false; if (typeof desc.configurable !== 'boolean' || typeof desc.enumerable !== 'boolean') { return false; } let keys = Object.keys(desc); if (isDataDesc(keys)) { if (typeof desc.get !== 'function' && desc.get !== void 0) return false; if (typeof desc.set !== 'function' && desc.set !== void 0) return false; return true; } if (isAccessorDesc(keys)) { return typeof desc.writable === 'boolean'; } return false; }; function isDataDesc(keys) { return keys.every(k => dataDesc.has(k)); } function isAccessorDesc(keys) { return keys.every(k => accDesc.has(k)); } is-descriptor-3.0.0/package.json000066400000000000000000000026651340462635300166060ustar00rootroot00000000000000{ "name": "is-descriptor", "description": "Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.", "version": "3.0.0", "homepage": "https://github.com/jonschlinkert/is-descriptor", "author": "Jon Schlinkert (https://github.com/jonschlinkert)", "contributors": [ "(https://github.com/wtgtybhertgeghgtwtg)", "Brian Woodward (https://twitter.com/doowb)", "Jon Schlinkert (http://twitter.com/jonschlinkert)" ], "repository": "jonschlinkert/is-descriptor", "bugs": { "url": "https://github.com/jonschlinkert/is-descriptor/issues" }, "license": "MIT", "files": [ "index.js" ], "main": "index.js", "engines": { "node": ">=6" }, "scripts": { "test": "mocha" }, "devDependencies": { "gulp-format-md": "^2.0.0", "mocha": "^5.2.0" }, "keywords": [ "accessor", "check", "data", "descriptor", "get", "getter", "is", "keys", "object", "properties", "property", "set", "setter", "type", "valid", "value" ], "verb": { "related": { "list": [ "is-accessor-descriptor", "is-data-descriptor", "is-descriptor", "isobject" ] }, "plugins": [ "gulp-format-md" ], "toc": false, "layout": "default", "tasks": [ "readme" ], "lint": { "reflinks": true } } } is-descriptor-3.0.0/test.js000066400000000000000000000064321340462635300156310ustar00rootroot00000000000000'use strict'; require('mocha'); const assert = require('assert'); const isDescriptor = require('./'); function noop() {} describe('isDescriptor', () => { describe('value type', () => { it('should be false when not an object:', () => { assert(!isDescriptor('a')); assert(!isDescriptor(null)); assert(!isDescriptor([])); }); }); describe('check for descriptor', () => { it('should return true if the property exists', () => { let obj = {}; obj.foo = null; Object.defineProperty(obj, 'bar', { value: 'xyz' }); Object.defineProperty(obj, 'baz', { get() { return 'aaa'; } }); Reflect.defineProperty(obj, 'qux', { value: 'xyz' }); assert(isDescriptor(obj, 'foo')); assert(isDescriptor(obj, 'bar')); assert(isDescriptor(obj, 'baz')); assert(isDescriptor(obj, 'qux')); }); }); describe('data descriptor:', () => { it('should be false when the object has invalid properties:', () => { assert(!isDescriptor({ value: 'foo', get: noop })); assert(!isDescriptor({ get: noop, value: noop })); }); it('should be false when the object has unrecognized properties:', () => { assert(!isDescriptor({ value: 'foo', bar: 'baz' })); assert(!isDescriptor({ value: 'foo', bar: 'baz' })); }); it('should be false when not descriptors', () => { assert(!isDescriptor({ value: 'foo' })); assert(!isDescriptor({ value: noop })); }); it('should be false when a value is not the correct type:', () => { assert(!isDescriptor({ value: 'foo', enumerable: 'foo' })); assert(!isDescriptor({ value: 'foo', configurable: 'foo' })); assert(!isDescriptor({ value: 'foo', writable: 'foo' })); }); }); describe('accessor descriptor:', () => { it('should be false when the object has invalid properties:', () => { assert(!isDescriptor({ get: noop, writable: true })); assert(!isDescriptor({ get: noop, value: true })); }); it('should be false when the object has unrecognize properties:', () => { assert(!isDescriptor({ get: noop, set: noop, bar: 'baz' })); }); it('should be false when an accessor is not a function:', () => { assert(!isDescriptor({ get: noop, set: 'baz' })); assert(!isDescriptor({ get: 'foo', set: noop })); assert(!isDescriptor({ get: 'foo', bar: 'baz' })); assert(!isDescriptor({ get: 'foo', set: 'baz' })); }); it('should be false when "get" is not a function', () => { assert(!isDescriptor({ set: noop })); assert(!isDescriptor({ get: 'foo' })); }); it('should be true when the object has all necessary properties', () => { assert(isDescriptor({ get: noop, set: noop, configurable: true, enumerable: true })); }); it('should not be true when the object does not have all necessary properties', () => { assert(!isDescriptor({ get: noop, set: noop })); assert(!isDescriptor({ get: noop })); }); it('should be false when a value is not the correct type:', () => { assert(!isDescriptor({ get: noop, set: noop, enumerable: 'foo' })); assert(!isDescriptor({ set: noop, configurable: 'foo' })); assert(!isDescriptor({ get: noop, configurable: 'foo' })); }); }); });