/js-parse-args

is a generic utility for merging together an array of arguments and an array of default values.

Primary LanguageJavaScriptMIT LicenseMIT

JS Parse Args

NPM version Downloads

is a generic utility for merging together an array of arguments and an array of default values.

Installation

NPM

npm install js-parse-args

Script Include

<script src="https://raw.githubusercontent.com/varunsridharan/js-parse-args/main/dist/js-parse-args.min.js"/></script>

Usage

NPM Usage

const parse_args = require('js-parse-args');

// Parse Args 
let $_args = parse_args($args,$defaults);

// Nested Parse Args
let $_args = parse_args($args,$defaults,true);

Manual

Parse Args

Merges the elements of one or more arrays together so that the values of one are appended to the end of the previous one. It returns the resulting array.

var $args = {
	key1:"KEY1",
	key2:"KEY2",
};

var $defaults = {
	key1:"DEFAULT1",
	key2:"DEFAULT2",
	key3:"DEFAULT3",
};

console.log(parse_args($args,$defaults));

Parse Args Nested

Merges the elements of one or more arrays together so that the values of one are appended to the end of the previous one. It returns the resulting array.

var $args = {
	key1:"KEY1",
	key2:"KEY2",
	key3:{
		key31:"KEY31",
	}
};

var $defaults = {
	key1:"DEFAULT1",
	key2:"DEFAULT2",
	key3:{
		key31:"DEFAULT31",
        key32:"DEFAULT32",
        key33:"DEFAULT33",
	}
};

console.log(parse_args($args,$defaults,true));

📝 Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🤝 Contributing

If you would like to help, please take a look at the list of issues.

💰 Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

  • ☕ How about we get to know each other over coffee? Buy me a cup for just $9.99
  • ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
  • 🔰 We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
  • 🚀 Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

📜 License & Conduct

📣 Feedback

  • ⭐ This repository if this project helped you! 😉
  • Create An 🔧 Issue if you need help / found a bug

Connect & Say 👋

Built With ♥ By Varun Sridharan 🇮🇳