merge-options-default v1.0.2

Merge Options Default

merge-options-default is a very simple library, so simple that it only provides one function, and the function works the parameters, with the default parameter, we call it options, since they are received through an object !

📦 Installation

In order to start using the merge function, we'll first need to install it as follows.

# To install
npm install --save merge-options-default

Usage

As I mentioned, merge-options-default has only one function, so it is easier to use than you think !

const merge = require('merge-options-default');

// Here's the example

// First we will create the object with the default options
const defaultOptions = {
   isGlobal: false,
   url: 'http://localhost',
   port: 8080,
};

function funcionPrueba(options) {
   options = merge(defaultOptions, options);
   return options;
}

// We execute the function without any parameter
funcionPrueba({
   isGlobal: true,
});
// Return to:
/*
   {
      isGlobal: true,
      url: 'http://localhost',
      port: 8080,
   }
   */

Let's understand how the function works, the function Merge receives unlimited objects of type object as parameters

• The variable defaultOptions is the default object, that is if it doesn't exist, another one with the name authorName, it will be added what you added in the object defaultOptions.
• The variable options is the object that will replace the defaultOptions.

// Default options
const defaultOptions = {
   authorName: 'Samuel Calsin',
};

// These are the options that replace the default options.
const options = {
   authorName: 'Yoni Calsin',
};
merge(defaultOptions, options);

Example 2

One last feature, I mentioned earlier that the merge function receives unlimited objects as parameters, that's true !

And of course I'll show you:

// 1: Default options
const defaultOptions = {
   authorName: 'Samuel Calsin',
};

// 2: Main Options
const options = {
   authorName: 'Yoni Calsin',
};

// 3: Extra options
// Example for author socials
const options3 = {
   twitter: 'https://twitter.com/yoicalsin',
   github: 'https://github.com/yoicalsin',
   instagram: 'https://www.instagram.com/yoicalsin',
};

// 4: Extra options
const options4 = {
   country: 'Peru',
};

// You can add unlimited options
// ....

const returnOptions = merge(defaultOptions, options, options3, options4);
console.log(returnOptions);
// And surely you can imagine that this will come back !
/*
{
  authorName: 'Yoni Calsin',
  twitter: 'https://twitter.com/yoicalsin',
  github: 'https://github.com/yoicalsin',
  instagram: 'https://www.instagram.com/yoicalsin',
  country: 'Peru'
}
*/

⭐ Support for

merge-options-default is an open source project licensed by MIT. You can grow thanks to the sponsors and the support of the amazing sponsors. If you want to join them, contact me here.

🎩 Stay in touch

• Author Yoni Calsin
• Twitter Yoni Calsin

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

📜 License

merge-options-default is MIT licensed.