RoleOption class final

A command line option of a role, such as --start of the router.

Constructors

RoleOption({required String name, required String help, String? valueHelp, List<String>? allowed})

Creates the option --<name>.

const

RoleOption.mode({required String name, required String help, required List<String> values})

Creates the mode option --<name>, which takes one of values.

const

Properties

allowed → List<String>?

The allowed values, or null to allow any; the values of a mode option, the default first.

final

hashCode → int

The hash code for this object.

no setter, inherited

help → String

What the option does, for --help.

final

isMode → bool

Whether the option is a mode of the app, whose values each get apps in the tests; see RoleOption.mode.

final

name → String

The name of the option without dashes, in lower kebab-case, such as start.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

valueHelp → String?

The placeholder of the value in --help, such as path.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited