CliRoute class

A registered route, as exposed to the outside: its command words, its positional parameters, and the option schema that applies to it.

Constructors

CliRoute({required String pattern, required List<String> positionals, required List<OptionSpec> options, required bool globals, String? optionalParam, bool hasWildcard = false, String? description})

const

Properties

description → String?

final

globals → bool

Whether the router's global options also apply to this route.

final

hashCode → int

The hash code for this object.

no setter, inherited

hasWildcard → bool

Whether the route ends in a * wildcard.

final

optionalParam → String?

The name of the trailing [<name>] segment, if the route ends in one.

final

options → List<OptionSpec>

This route's own option schema (not including globals).

final

pattern → String

The route's command words and required <name> placeholders, space separated, mount prefixes included (e.g. commands show <name>, eval rpn). Never includes a trailing [<name>] or *; see optionalParam and hasWildcard for that.

final

positionals → List<String>

Names of every positional parameter this route binds, in declaration order, required ones and the trailing optional one (if any) alike.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited