Package Exports
- oargv
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (oargv) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
oargv

Turns an object into a bash command.
Installation
$ npm i --save oargv
Example
// Dependencies
var OArgv = require("oargv");
console.log(OArgv({
r: true
, _: ["target.zip", "somedir"]
}, "zip", true));
// => zip "-r" "target.zip" "somedir"
console.log(OArgv({
d: "http://ionicabizau.net"
, tt: true
, size: "600x800"
}, "bat", true));
// => bat "-d" "http://ionicabizau.net" "--tt" "--size" "600x800"
console.log(OArgv({
escaping: "She said: \"Hello World\"!"
}, "foo", true));
// => foo "--escaping" "She said: \"Hello World\"!"
console.log(OArgv({
noCommand: "foo"
, b: true
}));
// => [ '--noCommand', 'foo', '-b' ]
console.log(OArgv({
__: "="
, custom: "Separator"
}, "foo"));
// => [ 'foo', '--custom=Separator' ]
console.log(OArgv({
author: ["foo@bar.com", "bar@foo.com"]
}));
// => [ '--author', 'foo@bar.com', '--author', 'bar@foo.com' ]
console.log(OArgv({
author: ["foo@bar.com", "bar@foo.com"]
}, true));
// => "--author" "foo@bar.com" "--author" "bar@foo.com"
console.log(OArgv({
author: ["foo@bar.com", "bar@foo.com"]
, __: "="
}, true));
// => "--author=foo@bar.com" "--author=bar@foo.com"
Documentation
OArgv(options, prgm, stringify)
Stringifies the options, building a command.
Params
- Object
options
: The options that should be stringified. If it contains the_
field, then this should be anArray
of strings, that representing values that will be added at the end of the command. The__
field is the separator (default:" "
). - String
prgm
: The program that executes the command (default:""
). - Boolean
stringify
: Iftrue
, the result array will be stringified (default:false
).
Return
- String|Array The stringified arguments (if
stringify
istrue
) or the array of arguments.
How to contribute
Have an idea? Found a bug? See how to contribute.
Where is this library used?
If you are using this library in one of your projects, add it in this list. ✨
engine-tools
by jillix