Documentation

Module: argv

This module contains default application command line arguments definitions.

Version:
  • 0.0.1
Since:
  • 0.0.1
Author:
See:

Example

// Example of uses of arguments :
cross-env NODE_ENV=development host=192.168.1.123 port=741258 protocol=https
// or
cross-env NODE_ENV=development -h 192.168.1.123 -p 741258 -o https

Members

<static> host :object

The main hostname argument used by the Server.

Type:
  • object
Properties:
Name Type Description
alias string

The argument alias.
describe string

The argument description.
demand boolean

Defines if the argument is required.
default string

The argument default value.
parseValues boolean

Parse values or not.
Since:
  • 0.0.1
Default Value:
  • undefined
Example
// Example how to pass the host argument
cross-env -h=127.0.0.1
// or
cross-env host=192.168.1.2

<static> port :object

The main port argument used by the Server.

Type:
  • object
Properties:
Name Type Description
alias string

The argument alias.
describe string

The argument description.
demand boolean

Defines if the argument is required.
default string

The argument default value.
parseValues boolean

Parse values or not.
Since:
  • 0.0.1
Default Value:
  • undefined
Example
// Example how to pass the port argument
cross-env -p=75000
// or
cross-env port=75000

<static> protocol :object

The main protocol argument used by the Server.

Type:
  • object
Properties:
Name Type Description
alias string

The argument alias.
describe string

The argument description.
demand boolean

Defines if the argument is required.
default string

The argument default value.
parseValues boolean

Parse values or not.
Since:
  • 0.0.1
Default Value:
  • undefined
Example
// Example how to pass the protocol argument
cross-env -o=https
// or
cross-env protocol=https