node-vargs

0.0.4 • Public • Published

node-vargs

Optional arguments made easy.

NPM

Purpose

Purpose of this module is to handle optional arguments easily and efficiently.

Installation

npm install node-vargs --save

Run tests

npm test

Run coverage

npm run cover

Examples

optional arguments
"use strict";
 
var vargs = require('node-vargs');
 
function getUserList(age, sex, callback) {
  // called with getUserList(18, function(list) {});
  var args = vargs(arguments, 3);
 
  age      = args.arg1 || 0;
  sex      = args.arg2 || 'female';
  callback = args.arg3;
 
  console.log(age); // 18
  console.log(sex); // female
 
  callback([12, 18]);
}
 
getUserList(18, function(result) {
  console.log(result); // [12, 18];
});
 
// NOTE: number of arguments passed is totoal number of arguments, including callback
optional arguments with default value
"use strict";
 
var vargs = require('node-vargs');
 
function makePicture(color, shape, options) {
  // called with makePicture('Orange');
  var args = vargs(arguments, ['Red', 'Rectangle', {create_new : true}]);
 
  console.log(args.arg1); // Orange
  console.log(args.arg2); // Rectangle
  console.log(args.arg3); // {create_new : true}
}
 
makePicture('Orange');
 
// NOTE: total number of elements in default values array must match total number of arguments
// in function, including callback. See example below
 
optional arguments with default value and callback
 
"use strict";
 
var vargs = require('node-vargs');
 
function makePicture(color, shape, options, callback) {
  // called with makePicture('Orange');
  var args = vargs(arguments, ['Red', 'Rectangle', {create_new : true}, function(picture) { }]);
 
  console.log(args.arg1); // Orange
  console.log(args.arg2); // Rectangle
  console.log(args.arg3); // {create_new : true}
}
 
makePicture('Orange');
 

For more details, see test/vargs.test.js

Package Sidebar

Install

npm i node-vargs

Weekly Downloads

1

Version

0.0.4

License

MIT

Last publish

Collaborators

  • tibabit