diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..096746c --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ +/node_modules/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..fba1839 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# default-value + +TODO + +## License + +[WTFPL](http://www.wtfpl.net/txt/copying/) or [CC0](https://creativecommons.org/publicdomain/zero/1.0/), whichever you prefer. A donation and/or attribution are appreciated, but not required. + +## Donate + +My income consists largely of donations for my projects. If this module is useful to you, consider [making a donation](http://cryto.net/~joepie91/donate.html)! + +You can donate using Bitcoin, PayPal, Flattr, cash-in-mail, SEPA transfers, and pretty much anything else. + +## Contributing + +Pull requests welcome. Please make sure your modifications are in line with the overall code style, and ensure that you're editing the files in `src/`, not those in `lib/`. + +Build tool of choice is `gulp`; simply run `gulp` while developing, and it will watch for changes. + +Be aware that by making a pull request, you agree to release your modifications under the licenses stated above. + +## Usage + +TODO + +## API + +TODO \ No newline at end of file diff --git a/gulpfile.js b/gulpfile.js new file mode 100644 index 0000000..1769501 --- /dev/null +++ b/gulpfile.js @@ -0,0 +1,18 @@ +var gulp = require("gulp"); +var presetES2015 = require("@joepie91/gulp-preset-es2015"); + +var source = ["src/**/*.js"] + +gulp.task('babel', function() { + return gulp.src(source) + .pipe(presetES2015({ + basePath: __dirname + })) + .pipe(gulp.dest("lib/")); +}); + +gulp.task("watch", function () { + gulp.watch(source, ["babel"]); +}); + +gulp.task("default", ["babel", "watch"]); \ No newline at end of file diff --git a/index.js b/index.js new file mode 100644 index 0000000..507257b --- /dev/null +++ b/index.js @@ -0,0 +1,3 @@ +'use strict'; + +module.exports = require("./lib"); \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..25193ad --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "name": "default-value", + "version": "0.0.1", + "description": "Lets you easily define a default value for undefined options, with optional support for Promises", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "http://git.cryto.net/joepie91/node-default-value.git" + }, + "keywords": [ + "default" + ], + "author": "Sven Slootweg", + "license": "WTFPL", + "dependencies": { + "es6-promise-try": "0.0.1" + }, + "devDependencies": { + "@joepie91/gulp-preset-es2015": "^1.0.1", + "babel-preset-es2015": "^6.6.0", + "gulp": "^3.9.1" + } +} diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..979df52 --- /dev/null +++ b/src/index.js @@ -0,0 +1,35 @@ +'use strict'; + +const promiseTry = require("es6-promise-try"); + +function evaluateValue(value) { + if (typeof value === "function") { + return value(); + } else { + return value; + } +} + +function defaultValue(value, fallbackValue) { + value = evaluateValue(value); + + if (value != null) { + return value; + } else { + return evaluateValue(fallbackValue); + } +} + +defaultValue.async = function defaultAsyncValue(value, fallbackValue) { + return promiseTry(() => { + return evaluateValue(value); + }).then((resultValue) => { + if (resultValue != null) { + return resultValue; + } else { + return evaluateValue(fallbackValue); + } + }) +} + +module.exports = defaultValue; \ No newline at end of file diff --git a/test.js b/test.js new file mode 100644 index 0000000..25a1749 --- /dev/null +++ b/test.js @@ -0,0 +1,21 @@ +'use strict'; + +const promiseTry = require("es6-promise-try"); +const defaultValue = require("./"); + +function promiseThatReturns(value) { + return Promise.resolve(value); +} + +console.log(defaultValue(null, () => 4)); +console.log(defaultValue("foo", "bar")); + +promiseTry(() => { + return Promise.all([ + defaultValue.async(promiseThatReturns(undefined), promiseThatReturns(Infinity)), + defaultValue.async(() => promiseThatReturns("baz"), promiseThatReturns("qux")) + ]); +}).then((results) => { + console.log(results[0]); + console.log(results[1]); +}) \ No newline at end of file