curlew.js

curlew.js is a simple arguments parser in NodeJS.

• curlew.js
• Installation
  • With NPM (recommended)
  • With Git
• Usage
  • Import
  • Example
  • Options

Installation

With NPM (recommended)

npm install curlew.js --save

With Git

git clone https://github.com/Treast/curlew.js.git mv ./curlew.js/curlew.js ./foo/bar

Usage

Import

const arguments = require('curlew.js').init();'

Example

// Called script: "node example.js --firstKey firstValue --secondKey -a bar baz"
import curlew from './curlew';

const defaults = {
  key: 'value',
};

const args = curlew.init(defaults);
console.log(args);
/*
	{
		key: 'value',
		_: [ 'baz' ],
		firstKey: 'firstValue',
		secondKey: true,
		a: 'bar'
	}
	*/

Options

Name	Informations
default(Object)	Default values (optionnal)