aboutsummaryrefslogtreecommitdiff
path: root/node_modules/has-value/README.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-12-10 21:51:33 +0100
committerFlorian Dold <florian.dold@gmail.com>2017-12-10 21:51:33 +0100
commit0469abd4a9c9270a1fdc962969e36e63699af8b4 (patch)
treef9864d4a4148621378958794cbbfdc2393733283 /node_modules/has-value/README.md
parent6947e79bbc258f7bc96af424ddb71a511f0c15a3 (diff)
upgrade dependencies
Diffstat (limited to 'node_modules/has-value/README.md')
-rw-r--r--node_modules/has-value/README.md117
1 files changed, 68 insertions, 49 deletions
diff --git a/node_modules/has-value/README.md b/node_modules/has-value/README.md
index a927633e5..f9b428c9a 100644
--- a/node_modules/has-value/README.md
+++ b/node_modules/has-value/README.md
@@ -1,4 +1,4 @@
-# has-value [![NPM version](https://img.shields.io/npm/v/has-value.svg?style=flat)](https://www.npmjs.com/package/has-value) [![NPM downloads](https://img.shields.io/npm/dm/has-value.svg?style=flat)](https://npmjs.org/package/has-value) [![Build Status](https://img.shields.io/travis/jonschlinkert/has-value.svg?style=flat)](https://travis-ci.org/jonschlinkert/has-value)
+# has-value [![NPM version](https://img.shields.io/npm/v/has-value.svg?style=flat)](https://www.npmjs.com/package/has-value) [![NPM monthly downloads](https://img.shields.io/npm/dm/has-value.svg?style=flat)](https://npmjs.org/package/has-value) [![NPM total downloads](https://img.shields.io/npm/dt/has-value.svg?style=flat)](https://npmjs.org/package/has-value) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/has-value.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/has-value)
> Returns true if a value exists, false if empty. Works with deeply nested values using object paths.
@@ -7,14 +7,14 @@
Install with [npm](https://www.npmjs.com/):
```sh
-$ npm install has-value --save
+$ npm install --save has-value
```
**Works for:**
* booleans
* functions
-* numbers (pass `true` as the last arg to treat zero as a value instead of falsey)
+* numbers
* strings
* nulls
* object
@@ -22,49 +22,57 @@ $ npm install has-value --save
## Usage
-Works with nested object paths or a single value:
+Works with property values (supports object-path notation, like `foo.bar`) or a single value:
```js
var hasValue = require('has-value');
-hasValue({a: {b: {c: 'foo'}}} 'a.b.c');
-//=> true
-
-hasValue('a');
+hasValue('foo');
+hasValue({foo: 'bar'}, 'foo');
+hasValue({a: {b: {c: 'foo'}}}, 'a.b.c');
//=> true
hasValue('');
+hasValue({foo: ''}, 'foo');
//=> false
-hasValue(1);
-//=> true
-
hasValue(0);
-//=> false
-
-hasValue(0, true); // pass `true` as the last arg to treat zero as a value
-//=> true
-
-hasValue({a: 'a'}});
+hasValue(1);
+hasValue({foo: 0}, 'foo');
+hasValue({foo: 1}, 'foo');
+hasValue({foo: null}, 'foo');
+hasValue({foo: {bar: 'a'}}}, 'foo');
+hasValue({foo: {bar: 'a'}}}, 'foo.bar');
//=> true
-hasValue({}});
+hasValue({foo: {}}}, 'foo');
+hasValue({foo: {bar: {}}}}, 'foo.bar');
+hasValue({foo: undefined}, 'foo');
//=> false
-hasValue(['a']);
-//=> true
-
hasValue([]);
+hasValue([[]]);
+hasValue([[], []]);
+hasValue([undefined]);
+hasValue({foo: []}, 'foo');
//=> false
-hasValue(function(foo) {}); // function length/arity
+hasValue([0]);
+hasValue([null]);
+hasValue(['foo']);
+hasValue({foo: ['a']}, 'foo');
//=> true
-hasValue(function() {});
-//=> false
+hasValue(function() {})
+hasValue(function(foo) {})
+hasValue({foo: function(foo) {}}, 'foo');
+hasValue({foo: function() {}}, 'foo');
+//=> true
hasValue(true);
hasValue(false);
+hasValue({foo: true}, 'foo');
+hasValue({foo: false}, 'foo');
//=> true
```
@@ -73,58 +81,69 @@ hasValue(false);
To do the opposite and test for empty values, do:
```js
-function isEmpty(o, isZero) {
+function isEmpty(o) {
return !hasValue.apply(hasValue, arguments);
}
```
-## Related projects
+## Release history
-You might also be interested in these projects:
+### v1.0.0
-* [get-object](https://www.npmjs.com/package/get-object): Get a property from an object using dot (object path) notation. | [homepage](https://github.com/jonschlinkert/get-object)
-* [get-property](https://www.npmjs.com/package/get-property): Get a nested property or its value from an object using simple `a.b.c` paths. | [homepage](https://github.com/jonschlinkert/get-property)
-* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value)
-* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value)
+* `zero` always returns true
+* `array` now recurses, so that an array of empty arrays will return `false`
+* `null` now returns true
-## Contributing
+## About
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/has-value/issues/new).
+### Related projects
-## Building docs
+* [define-property](https://www.npmjs.com/package/define-property): Define a non-enumerable property on an object. | [homepage](https://github.com/jonschlinkert/define-property "Define a non-enumerable property on an object.")
+* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value "Use property paths (`a.b.c`) to get a nested value from an object.")
+* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value "Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths.")
+* [unset-value](https://www.npmjs.com/package/unset-value): Delete nested properties from an object using dot notation. | [homepage](https://github.com/jonschlinkert/unset-value "Delete nested properties from an object using dot notation.")
-Generate readme and API documentation with [verb](https://github.com/verbose/verb):
+### Contributing
-```sh
-$ npm install verb && npm run docs
-```
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+
+### Contributors
+
+| **Commits** | **Contributor** |
+| --- | --- |
+| 17 | [jonschlinkert](https://github.com/jonschlinkert) |
+| 2 | [rmharrison](https://github.com/rmharrison) |
+
+### 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.)_
-Or, if [verb](https://github.com/verbose/verb) is installed globally:
+To generate the readme, run the following command:
```sh
-$ verb
+$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
-## Running tests
+### Running tests
-Install dev dependencies:
+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 -d && npm test
+$ npm install && npm test
```
-## Author
+### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
-* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
-## License
+### License
-Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
-Released under the [MIT license](https://github.com/jonschlinkert/has-value/blob/master/LICENSE).
+Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT License](LICENSE).
***
-_This file was generated by [verb](https://github.com/verbose/verb), v, on March 27, 2016._ \ No newline at end of file
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 19, 2017._ \ No newline at end of file