LiveCommandSchema class

A live command as reported by the running app.

Constructors

LiveCommandSchema({required String name, String? description, List<LiveCommandOption> options = const []})
Creates a LiveCommandSchema.
const

Properties

description → String?
The one-line description, when the app provides one.
final
hashCode → int
The hash code for this object.
no setterinherited
name → String
The full category:name.
final
options → List<LiveCommandOption>
The declared options and flags.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
usage → String
Usage text for --help.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parse(List<String> arguments) → ({List<String> rest, Map<String, Object?> values})
Parses terminal arguments against this schema.
toArgParser() → ArgParser
Builds the ArgParser Metro uses to validate terminal arguments.
toString() → String
A string representation of this object.
inherited
wantsHelp(List<String> arguments) → bool
Whether arguments ask for help without the command claiming --help or -h for itself.

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromJson(Object? json) → LiveCommandSchema?
Parses one entry of ext.nylo.commands.list.
listFromResult(Object? result) → List<LiveCommandSchema>
Parses the commands list of an ext.nylo.commands.list result.