CliRequest class

A concrete, resolved invocation, handed to a route's CliHandler.

Constructors

CliRequest({required List<String> originalArgs, required CliRoute route, required Map<String, String> params, required List<String> rest, required List<ParsedOption> options, IOSink? stdout, IOSink? stderr})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

options → List<ParsedOption>

Every option read on the invocation, in argv order, exactly as written.

final

originalArgs → List<String>

The exact args passed to CliRouter.run.

final

params → Map<String, String>

Bound values for the route's positional parameters that were present.

final

rest → List<String>

Operands collected by a trailing * wildcard; empty otherwise.

final

route → CliRoute

The route that matched.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stderr → IOSink

final

stdout → IOSink

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

option(String name) → ParsedOption?

The first occurrence of option name, or null if it was not read on this invocation. For a repeatable option that occurred more than once, see options for every occurrence.

param(String name) → String?

The bound value for positional parameter name, or null if it was not declared by the route or not present (an unconsumed optional one).

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited