Module

Node.Yargs

Low-level bindings to the yargs library.

For a more idiomatic interface, consider using the Node.Yargs.Applicative module.

data Yargs :: Type

The type of the yargs module, i.e. the result of require('yargs').

yargs :: Effect Yargs

Get a reference to the yargs module.

runYargs :: YargsSetup -> Effect Foreign

Setup the yargs module and get the resulting parsed command line arguments object.

argv :: Yargs -> Effect Foreign

Get the raw command line arguments object, as a foreign value.

setupWith :: YargsSetup -> Yargs -> Effect Yargs

Setup the yargs module.

See the Node.Yargs.Setup module, which contains functions for creating values of type YargsSetup.