ul

A minimalist utility library.

:cloud: Installation

# Using npm
npm install --save ul

# Using yarn
yarn add ul

:clipboard: Example

import Ul from "ul";

// Input data
let obj = {
    n: null,
    v: 1
};

let def = {
    n: 1,
    v: 10,
    a: 20
};

let tmp;

// 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 } }

:memo: Documentation

merge(dst, src)

One-level merge. Faster than deepMerge.

Params

• object dst: The destination object.
• object src: The source object (usually defaults).

Return

• object The result object.

deepMerge()

Recursively merges the objects from the arguments, returning a new object.

Usage: Ul.deepMerge(obj1, obj2, obj3, obj4, ..., objN)

Return

• object The merged objects.

clone(item)

Creates a deep clone of the provided item.

Params

• object|Array item: The item that should be cloned

Return

• object|Array The cloned object

home()

Gets the home directory path on any platform. The value can also be accessed using Ul.HOME_DIR.

Return

• string The home directory path.

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. 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. :rocket:

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

: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:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —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:

:scroll: License

MIT © Ionică Bizău