267 lines
5.2 KiB
Markdown
Executable File
267 lines
5.2 KiB
Markdown
Executable File
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[](#)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# deffy
|
|
|
|
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/deffy) [](https://www.npmjs.com/package/deffy) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
|
|
|
|
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
> Small and fast library to set default values.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :cloud: Installation
|
|
|
|
```sh
|
|
# Using npm
|
|
npm install --save deffy
|
|
|
|
# Using yarn
|
|
yarn add deffy
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :clipboard: Example
|
|
|
|
|
|
|
|
```js
|
|
// Dependencies
|
|
var Deffy = require("deffy");
|
|
|
|
console.log(Deffy(undefined, "Hello World"));
|
|
// => "Hello World"
|
|
|
|
console.log(Deffy("Hello World", 42));
|
|
// => 42
|
|
|
|
console.log(Deffy("Hello", "World"));
|
|
// => "World"
|
|
|
|
console.log(Deffy("", "World", true));
|
|
// => "World"
|
|
|
|
console.log(Deffy("", "World"));
|
|
// => ""
|
|
|
|
console.log(Deffy("foo", function (input) {
|
|
return input === "foo" ? "bar" : "foo";
|
|
}));
|
|
// => "bar"
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :question: Get Help
|
|
|
|
There are few ways to get help:
|
|
|
|
|
|
|
|
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
|
|
2. For bug reports and feature requests, open issues. :bug:
|
|
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
|
|
|
|
|
|
|
|
|
|
|
|
## :memo: Documentation
|
|
|
|
|
|
### `Deffy(input, def, options)`
|
|
Computes a final value by providing the input and default values.
|
|
|
|
#### Params
|
|
|
|
- **Anything** `input`: The input value.
|
|
- **Anything|Function** `def`: The default value or a function getting the input value as first argument.
|
|
- **Object|Boolean** `options`: The `empty` value or an object containing the following fields:
|
|
|
|
- `empty` (Boolean): Handles the input value as empty field (`input || default`). Default is `false`.
|
|
|
|
#### Return
|
|
- **Anything** The computed value.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :yum: How to contribute
|
|
Have an idea? Found a bug? See [how to contribute][contributing].
|
|
|
|
|
|
## :sparkling_heart: Support my projects
|
|
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
|
|
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
|
|
|
|
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
|
|
|
|
|
|
- Starring and sharing the projects you like :rocket:
|
|
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
|
|
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
|
|
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
|
|
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
|
|
|
|
|
|
|
|
|
|
Thanks! :heart:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :dizzy: Where is this library used?
|
|
If you are using this library in one of your projects, add it in this list. :sparkles:
|
|
|
|
- `ul`
|
|
- `bug-killer`
|
|
- `tilda`
|
|
- `same-time`
|
|
- `cli-box`
|
|
- `bindy`
|
|
- `set-or-get`
|
|
- `emoji-logger`
|
|
- `pixel-class`
|
|
- `obj-def`
|
|
- `cli-gh-cal`
|
|
- `cute-logger`
|
|
- `bloggify-template-renderer`
|
|
- `git-package-json`
|
|
- `bloggify-contact-form`
|
|
- `transformer`
|
|
- `git-stats`
|
|
- `svg.connectable.js`
|
|
- `engine-parser`
|
|
- `flow-api`
|
|
- `engine-builder`
|
|
- `enny`
|
|
- `engine-flow-types`
|
|
- `engine-tools`
|
|
- `ghosty`
|
|
- `web-term`
|
|
- `asciify-pixel`
|
|
- `blah`
|
|
- `bloggify-shop`
|
|
- `bloggify-paths`
|
|
- `bloggify-theme-renderer`
|
|
- `ascii-heart`
|
|
- `gh-notifier`
|
|
- `love-you`
|
|
- `parrot-bot`
|
|
- `value-breakpoints`
|
|
- `@isysd/gpm`
|
|
- `gpm`
|
|
- `bloggify-ws`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :scroll: License
|
|
|
|
[MIT][license] © [Ionică Bizău][website]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[license]: /LICENSE
|
|
[website]: http://ionicabizau.net
|
|
[contributing]: /CONTRIBUTING.md
|
|
[docs]: /DOCUMENTATION.md
|
|
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
|
|
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
|
|
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
|
|
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
|
|
[patreon]: https://www.patreon.com/ionicabizau
|
|
[amazon]: http://amzn.eu/hRo9sIZ
|
|
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
|