interface Positional

Interface for SubCommand positional arguments.

Properties

readonly
optional
isVarargMultiple: boolean

If this is true the argument can be specified one or multiple times and all values will be returned in an array matching the order provided.

NOTE: If isVarargOptional is true, the argument can specified zero, one or multiple times.

NOTE: There can be only one positional with this set and it must be the last the last item if there are multiple positionals defined.

readonly
optional
isVarargOptional: boolean

If this is true the argument can be specified zero or once i.e. it does not need to be specified.

NOTE: If isVarargMultiple is true, the argument can specified zero, one or multiple times.

NOTE: There can be only one positional with this set and it must be the last the last item if there are multiple positionals defined.

Usage

import type Positional from ".";