Terminal class - terminal library

Constructors

Terminal.new()

Properties

activityBarWidth ↔ int: Available on Console, provided by the ActivityBarWidth extension
Returns current configured width of the console.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
size → (int, int): The size of the Console window. Used for calculating lines printed and centering text.
no setteroverride
stylizedOutputOverride ↔ bool: Available on Console, provided by the StylizedOutputOverride extension
Returns stylized ConsoleText output for the Console.
getter/setter pair
userinfo → Map: The current user's information.
final

Methods

ask(ConsoleText prompt, {bool secure = false, bool newline = true}) → String: Available on Console, provided by the ConsoleASK extension
Requests input from the console after displaying a prompt.
center(String text, {String padding = " "}) → String: Available on Console, provided by the ConsoleCenter extension
Centers a String according to this console's size.
centerLines(Iterable<String> lines, {String padding = " "}) → Iterable<String>: Available on Console, provided by the ConsoleCenter extension
Centers a iterable of String according to this console's size.
choose(ConsoleText prompt, {required List<ConsoleChooseItem<T>> items}) → T: Available on Console, provided by the ConsoleChoose extension
Requests a choice from the user after a prompt.
clear(ConsoleClear type) → void: Clears previously printed Console output according to the ConsoleClear type specified.
override
clearLines(int count) → void: Available on Console, provided by the ConsoleClearLines extension
Deletes lines that were previously printed to the console.
command(ANSICommand command) → void: Performs an ANSICommand.
confirm(ConsoleText prompt, {bool newline = false}) → bool: Available on Console, provided by the ConsoleConfirm extension
Requests yes / no confirmation from the user after a prompt.
createActivity({String? title, List<ConsoleText> frames = const [], String success = '✓', String failure = '✗'}) → ActivityIndicator<CustomActivityBar>: Available on Console, provided by the CreateCustomActivityBarIndicator extension
Creates a new ActivityIndicator with customizable frames and success and failure messages.
createLoadingBarIndicator({String? title, String failure = '✗', String success = '✓'}) → ActivityIndicator<LoadingBar>: Available on Console, provided by the CreateLoadingBarIndicator extension
Create a loading-style activity indicator.
createProgressBar({String? title, String success = '✓', String failure = '✗'}) → ActivityIndicator<ProgressBar>: Available on Console, provided by the CreateProgressBar extension
Creates a new ProgressBar.
didOutputLines(int count) → void: Available on Console, provided by the ConsoleEphemeral extension
Clears the console, preserving ephemeral text.
ephemeral() → void: Available on Console, provided by the ConsoleEphemeral extension
Pushes a new ephemeral console state. All text outputted to the console immidiately after this call will be deleted when the console is cleared.
error(String text, {bool newline = true}) → void: Available on Console, provided by the ConsoleOutput extension
Outputs a String to the console with ConsoleStyle.error.
info(String text, {bool newline = true}) → void: Available on Console, provided by the ConsoleOutput extension
Outputs a String to the console with ConsoleStyle.info.
input({bool secure = false}) → String: Returns a String of input read from the Console until a line feed character was found.
override
newline() → void: Available on Console, provided by the ConsoleOutput extension
Outputs a newline to the console.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
output(ConsoleText text, {bool newline = true}) → void: Outputs serialized ConsoleText to the Console.
override
plain(String text, {bool newline = true}) → void: Available on Console, provided by the ConsoleOutput extension
Outputs a String to the console with ConsoleStyle.plain.
report(ConsoleText text, {bool newline = true}) → void: Outputs an error to the Console's error stream.
override
run({required String executable, required Command command, Iterable<String> arguments = const []}) → Future<void>: Available on Console, provided by the ConsoleRun extension
Runs a Command with the given iterable of arguments.
runWithContext(Command command, CommandContext context) → Future<void>: Available on Console, provided by the ConsoleRun extension
Runs a Command with the given CommandContext.
runWithInput(Command command, CommandInput input) → Future<void>: Available on Console, provided by the ConsoleRun extension
Runs a Command with the given CommandInput.
success(String text, {bool newline = true}) → void: Available on Console, provided by the ConsoleOutput extension
Outputs a String to the console with ConsoleStyle.success.
toString() → String: A string representation of this object.
inherited
unephemeral() → void: Available on Console, provided by the ConsoleEphemeral extension
Pops the last ephemeral console state. All text outputted to the console immidiately after this call will be preserved when the console is cleared.
warning(String text, {bool newline = true}) → void: Available on Console, provided by the ConsoleOutput extension
Outputs a String to the console with ConsoleStyle.warning.
write(String text, {bool newline = true, ConsoleStyle style = ConsoleStyle.plain}) → void: Available on Console, provided by the ConsoleOutput extension

Operators

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