diff options
Diffstat (limited to 'node_modules/evaluate-value/README.md')
| -rw-r--r-- | node_modules/evaluate-value/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/node_modules/evaluate-value/README.md b/node_modules/evaluate-value/README.md new file mode 100644 index 0000000..8f835bb --- /dev/null +++ b/node_modules/evaluate-value/README.md @@ -0,0 +1,41 @@ +# evaluate-value [![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] + +> Return a value or an evaluated function (with arguments). + + +* When the first input argument is a function, it is executed with the remaining arguments, and the result is returned. +* When the first input argument is *not* a function, it is simply returned. + + +## Installation + +[Node.js](http://nodejs.org/) `>= 8` is required. To install, type this at the command line: +```shell +npm install evaluate-value +``` + + +## Usage + +```js +const evaluateValue = require('evaluate-value'); + +evaluateValue(true); +//-> true + +evaluateValue(() => true); +//-> true + +evaluateValue( + (arg1, arg2) => arg1 === arg2, + true, + false +); +//-> false +``` + + +[npm-image]: https://img.shields.io/npm/v/evaluate-value.svg +[npm-url]: https://npmjs.com/package/evaluate-value +[travis-image]: https://img.shields.io/travis/stevenvachon/evaluate-value.svg +[travis-url]: https://travis-ci.org/stevenvachon/evaluate-value |
