update, text, response
This commit is contained in:
183
node_modules/is-descriptor/README.md
generated
vendored
183
node_modules/is-descriptor/README.md
generated
vendored
@@ -1,42 +1,36 @@
|
||||
# is-descriptor [](https://www.npmjs.com/package/is-descriptor) [](https://npmjs.org/package/is-descriptor) [](https://npmjs.org/package/is-descriptor) [](https://travis-ci.org/jonschlinkert/is-descriptor)
|
||||
# is-descriptor <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
||||
|
||||
[![github actions][actions-image]][actions-url]
|
||||
[![coverage][codecov-image]][codecov-url]
|
||||
[![License][license-image]][license-url]
|
||||
[![Downloads][downloads-image]][downloads-url]
|
||||
|
||||
[![npm badge][npm-badge-png]][package-url]
|
||||
|
||||
> Returns true if a value has the characteristics of a valid JavaScript descriptor. Works for data descriptors and accessor descriptors.
|
||||
|
||||
## Install
|
||||
|
||||
Install with [npm](https://www.npmjs.com/):
|
||||
|
||||
```sh
|
||||
$ npm install --save is-descriptor
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
var isDescriptor = require('is-descriptor');
|
||||
const isDescriptor = require('is-descriptor');
|
||||
const assert = require('assert');
|
||||
|
||||
isDescriptor({value: 'foo'})
|
||||
//=> true
|
||||
isDescriptor({get: function(){}, set: function(){}})
|
||||
//=> true
|
||||
isDescriptor({get: 'foo', set: function(){}})
|
||||
//=> false
|
||||
assert.equal(isDescriptor({ value: 'foo' }), true);
|
||||
assert.equal(isDescriptor({ get() {}, set() {} }), true);
|
||||
assert.equal(isDescriptor({ get: 'foo', set() {} }), 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
|
||||
var obj = {};
|
||||
obj.foo = 'abc';
|
||||
const obj = { foo: 'abc' };
|
||||
|
||||
Object.defineProperty(obj, 'bar', {
|
||||
value: 'xyz'
|
||||
});
|
||||
|
||||
isDescriptor(obj, 'foo');
|
||||
//=> true
|
||||
isDescriptor(obj, 'bar');
|
||||
//=> true
|
||||
assert.equal(isDescriptor(obj, 'foo'), true);
|
||||
assert.equal(isDescriptor(obj, 'bar'), true);
|
||||
```
|
||||
|
||||
## Examples
|
||||
@@ -46,12 +40,9 @@ isDescriptor(obj, 'bar');
|
||||
`false` when not an object
|
||||
|
||||
```js
|
||||
isDescriptor('a');
|
||||
//=> false
|
||||
isDescriptor(null);
|
||||
//=> false
|
||||
isDescriptor([]);
|
||||
//=> false
|
||||
assert.equal(isDescriptor('a'), false);
|
||||
assert.equal(isDescriptor(null), false);
|
||||
assert.equal(isDescriptor([]), false);
|
||||
```
|
||||
|
||||
### data descriptor
|
||||
@@ -59,34 +50,25 @@ isDescriptor([]);
|
||||
`true` when the object has valid properties with valid values.
|
||||
|
||||
```js
|
||||
isDescriptor({value: 'foo'});
|
||||
//=> true
|
||||
isDescriptor({value: noop});
|
||||
//=> true
|
||||
assert.equal(isDescriptor({ value: 'foo' }), true);
|
||||
assert.equal(isDescriptor({ value() {} }), true);
|
||||
```
|
||||
|
||||
`false` when the object has invalid properties
|
||||
|
||||
```js
|
||||
isDescriptor({value: 'foo', bar: 'baz'});
|
||||
//=> false
|
||||
isDescriptor({value: 'foo', bar: 'baz'});
|
||||
//=> false
|
||||
isDescriptor({value: 'foo', get: noop});
|
||||
//=> false
|
||||
isDescriptor({get: noop, value: noop});
|
||||
//=> false
|
||||
assert.equal(isDescriptor({ value: 'foo', enumerable: 'baz' }), false);
|
||||
assert.equal(isDescriptor({ value: 'foo', configurable: 'baz' }), false);
|
||||
assert.equal(isDescriptor({ value: 'foo', get() {} }), false);
|
||||
assert.equal(isDescriptor({ get() {}, value() {} }), 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
|
||||
assert.equal(isDescriptor({ value: 'foo', enumerable: 'foo' }), false);
|
||||
assert.equal(isDescriptor({ value: 'foo', configurable: 'foo' }), false);
|
||||
assert.equal(isDescriptor({ value: 'foo', writable: 'foo' }), false);
|
||||
```
|
||||
|
||||
### accessor descriptor
|
||||
@@ -94,100 +76,59 @@ isDescriptor({value: 'foo', writable: 'foo'});
|
||||
`true` when the object has valid properties with valid values.
|
||||
|
||||
```js
|
||||
isDescriptor({get: noop, set: noop});
|
||||
//=> true
|
||||
isDescriptor({get: noop});
|
||||
//=> true
|
||||
isDescriptor({set: noop});
|
||||
//=> true
|
||||
assert.equal(isDescriptor({ get() {}, set() {} }), true);
|
||||
assert.equal(isDescriptor({ get() {} }), true);
|
||||
assert.equal(isDescriptor({ set() {} }), true);
|
||||
```
|
||||
|
||||
`false` when the object has invalid properties
|
||||
|
||||
```js
|
||||
isDescriptor({get: noop, set: noop, bar: 'baz'});
|
||||
//=> false
|
||||
isDescriptor({get: noop, writable: true});
|
||||
//=> false
|
||||
isDescriptor({get: noop, value: true});
|
||||
//=> false
|
||||
assert.equal(isDescriptor({ get() {}, set() {}, enumerable: 'baz' }), false);
|
||||
assert.equal(isDescriptor({ get() {}, writable: true }), false);
|
||||
assert.equal(isDescriptor({ get() {}, value: true }), false);
|
||||
```
|
||||
|
||||
`false` when an accessor is not a function
|
||||
|
||||
```js
|
||||
isDescriptor({get: noop, set: 'baz'});
|
||||
//=> false
|
||||
isDescriptor({get: 'foo', set: noop});
|
||||
//=> false
|
||||
isDescriptor({get: 'foo', bar: 'baz'});
|
||||
//=> false
|
||||
isDescriptor({get: 'foo', set: 'baz'});
|
||||
//=> false
|
||||
assert.equal(isDescriptor({ get() {}, set: 'baz' }), false);
|
||||
assert.equal(isDescriptor({ get: 'foo', set() {} }), false);
|
||||
assert.equal(isDescriptor({ get: 'foo', bar: 'baz' }), false);
|
||||
assert.equal(isDescriptor({ get: 'foo', set: 'baz' }), false);
|
||||
```
|
||||
|
||||
`false` when a value is not the correct type
|
||||
|
||||
```js
|
||||
isDescriptor({get: noop, set: noop, enumerable: 'foo'});
|
||||
//=> false
|
||||
isDescriptor({set: noop, configurable: 'foo'});
|
||||
//=> false
|
||||
isDescriptor({get: noop, configurable: 'foo'});
|
||||
//=> false
|
||||
assert.equal(isDescriptor({ get() {}, set() {}, enumerable: 'foo' }), false);
|
||||
assert.equal(isDescriptor({ set() {}, configurable: 'foo' }), false);
|
||||
assert.equal(isDescriptor({ get() {}, configurable: 'foo' }), false);
|
||||
```
|
||||
|
||||
## About
|
||||
|
||||
### Related 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.")
|
||||
You might also be interested in these projects:
|
||||
|
||||
### Contributing
|
||||
* [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.
|
||||
* [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.
|
||||
* [is-object](https://www.npmjs.com/package/is-object): Returns true if the value is an object and not an array or null.
|
||||
|
||||
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
||||
## Tests
|
||||
Simply clone the repo, `npm install`, and run `npm test`
|
||||
|
||||
### Contributors
|
||||
|
||||
| **Commits** | **Contributor** |
|
||||
| --- | --- |
|
||||
| 24 | [jonschlinkert](https://github.com/jonschlinkert) |
|
||||
| 1 | [doowb](https://github.com/doowb) |
|
||||
| 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
### Author
|
||||
|
||||
**Jon Schlinkert**
|
||||
|
||||
* [github/jonschlinkert](https://github.com/jonschlinkert)
|
||||
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
|
||||
|
||||
### License
|
||||
|
||||
Copyright © 2017, [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.6.0, on July 22, 2017._
|
||||
[package-url]: https://npmjs.org/package/is-descriptor
|
||||
[npm-version-svg]: https://versionbadg.es/inspect-js/is-descriptor.svg
|
||||
[deps-svg]: https://david-dm.org/inspect-js/is-descriptor.svg
|
||||
[deps-url]: https://david-dm.org/inspect-js/is-descriptor
|
||||
[dev-deps-svg]: https://david-dm.org/inspect-js/is-descriptor/dev-status.svg
|
||||
[dev-deps-url]: https://david-dm.org/inspect-js/is-descriptor#info=devDependencies
|
||||
[npm-badge-png]: https://nodei.co/npm/is-descriptor.png?downloads=true&stars=true
|
||||
[license-image]: https://img.shields.io/npm/l/is-descriptor.svg
|
||||
[license-url]: LICENSE
|
||||
[downloads-image]: https://img.shields.io/npm/dm/is-descriptor.svg
|
||||
[downloads-url]: https://npm-stat.com/charts.html?package=is-descriptor
|
||||
[codecov-image]: https://codecov.io/gh/inspect-js/is-descriptor/branch/main/graphs/badge.svg
|
||||
[codecov-url]: https://app.codecov.io/gh/inspect-js/is-descriptor/
|
||||
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/is-descriptor
|
||||
[actions-url]: https://github.com/inspect-js/is-descriptor/actions
|
||||
|
||||
Reference in New Issue
Block a user