367 lines
6.7 KiB
Markdown
Executable File
367 lines
6.7 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. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# ul
|
|
|
|
[![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://travis-ci.org/IonicaBizau/node-ul/) [](https://www.npmjs.com/package/ul) [](https://www.npmjs.com/package/ul) [](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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
> A minimalist utility library.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :cloud: Installation
|
|
|
|
```sh
|
|
# Using npm
|
|
npm install --save ul
|
|
|
|
# Using yarn
|
|
yarn add ul
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :clipboard: Example
|
|
|
|
|
|
|
|
```js
|
|
const Ul = require("ul")
|
|
|
|
// Input data
|
|
let obj = {
|
|
n: null
|
|
, v: 1
|
|
}
|
|
, def = {
|
|
n: 1
|
|
, v: 10
|
|
, a: 20
|
|
}
|
|
, tmp = null
|
|
|
|
|
|
// Merge the two objects and store the result in tmp
|
|
console.log(tmp = Ul.deepMerge(obj, def))
|
|
// => { n: null, v: 1, a: 20 }
|
|
|
|
// Clone the tmp object -- the clone will have a
|
|
// different reference
|
|
console.log(tmp === Ul.clone(tmp))
|
|
// => false
|
|
|
|
// Show the absolute path to the home directory
|
|
console.log(Ul.home()) // or `console.log(Ul.HOME_DIR)`
|
|
// => /home/ionicabizau
|
|
|
|
// One level merge
|
|
console.log(Ul.merge({
|
|
foo: {
|
|
bar: 42
|
|
}
|
|
}, {
|
|
foo: {
|
|
bar: 1
|
|
, baz: 7
|
|
}
|
|
}))
|
|
// => { { bar: 42 } }
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :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
|
|
|
|
|
|
### `merge(dst, src)`
|
|
One level merge. Faster than `deepMerge`.
|
|
|
|
#### Params
|
|
|
|
- **** `dst`: {Object} The destination object.
|
|
- **** `src`: {Object} The source object (usually defaults).
|
|
|
|
#### Return
|
|
- **Object** The result object.
|
|
|
|
### `deepMerge()`
|
|
Recursively merge the objects from arguments, returning a new object.
|
|
|
|
Usage: `Ul.deepMerge(obj1, obj2, obj3, obj4, ..., objN)`
|
|
|
|
#### Return
|
|
- **Object** The merged objects.
|
|
|
|
### `clone(item)`
|
|
Deep clone of the provided item.
|
|
|
|
#### Params
|
|
|
|
- **Anything** `item`: The item that should be cloned
|
|
|
|
#### Return
|
|
- **Anything** The cloned object
|
|
|
|
### `home()`
|
|
Get the home directory path on any platform. The value can be
|
|
accessed using `Ul.HOME_DIR` too.
|
|
|
|
#### Return
|
|
- **String** The home directory path.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :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:
|
|
|
|
- `abs`
|
|
- `tilda`
|
|
- `image-to-ascii`
|
|
- `cli-box`
|
|
- `lien`
|
|
- `le-table`
|
|
- `oargv`
|
|
- `tinyreq`
|
|
- `gry`
|
|
- `gh.js`
|
|
- `emoji-logger`
|
|
- `cli-pie`
|
|
- `streamp`
|
|
- `bloggify`
|
|
- `jsonrequest`
|
|
- `diable`
|
|
- `parent-search`
|
|
- `asciify-pixel-matrix`
|
|
- `fwatcher`
|
|
- `cli-gh-cal`
|
|
- `made-in`
|
|
- `bloggify-viewer`
|
|
- `promptify`
|
|
- `bloggify-markdown-adapter`
|
|
- `cli-graph`
|
|
- `class-methods`
|
|
- `git-cloner`
|
|
- `github-colors`
|
|
- `bloggify-template-renderer`
|
|
- `bible.js`
|
|
- `bloggify-social`
|
|
- `transformer`
|
|
- `bloggify-cli`
|
|
- `rucksack`
|
|
- `statique`
|
|
- `cli-snow`
|
|
- `git-stats`
|
|
- `match`
|
|
- `page-changed`
|
|
- `markdown-templator-fork`
|
|
- `bloggify-config`
|
|
- `engine-parser`
|
|
- `flow-api`
|
|
- `engine-builder`
|
|
- `enny`
|
|
- `engine-flow-types`
|
|
- `engine-tools`
|
|
- `packy`
|
|
- `np-init`
|
|
- `bloggify-plugin-class`
|
|
- `template-html`
|
|
- `markdown-templator`
|
|
- `bloggify-mongoose`
|
|
- `web-term`
|
|
- `ghcal`
|
|
- `gh-fork-source`
|
|
- `ghosty`
|
|
- `asciify-pixel`
|
|
- `ansy`
|
|
- `blah`
|
|
- `compute-size`
|
|
- `gh-contributions`
|
|
- `img-ssim`
|
|
- `mdify`
|
|
- `cli-circle`
|
|
- `cobol`
|
|
- `nodeice`
|
|
- `elasticfire`
|
|
- `bloggify-paths`
|
|
- `bloggify-sql-adapter`
|
|
- `bloggify-theme-renderer`
|
|
- `bible`
|
|
- `bloggify-sequelize-adapter`
|
|
- `wrabbit`
|
|
- `jipics`
|
|
- `ascii-heart`
|
|
- `share-term`
|
|
- `fortran`
|
|
- `phantom-jquery`
|
|
- `parrot-bot`
|
|
- `npmreserve`
|
|
- `regarde`
|
|
- `tithe`
|
|
- `tester-init`
|
|
- `tinyreq-cli`
|
|
- `tilda-init`
|
|
- `cdnjs-importer`
|
|
- `bloggify-sequelize`
|
|
- `@isysd/gpm`
|
|
- `bloggify-tools`
|
|
- `striking-clock`
|
|
- `ship-release`
|
|
- `donate.js`
|
|
- `3abn`
|
|
- `birthday`
|
|
- `bnotify`
|
|
- `gpm`
|
|
- `github-stats`
|
|
- `git-stats-importer`
|
|
- `idea`
|
|
- `mongof`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## :scroll: License
|
|
|
|
[MIT][license] © [Ionică Bizău][website]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[license]: /LICENSE
|
|
[website]: https://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
|