ConsoleProgressBar class

A class that displays a progress bar in the console.

Constructors

ConsoleProgressBar({required int total, String? message, int barWidth = 30})
Creates a ConsoleProgressBar with the given total steps.

Properties

current → int
Get the current progress value
no setter
hashCode → int
The hash code for this object.
no setterinherited
message ↔ String?
Optional message displayed alongside the progress bar.
getter/setter pair
percentage → double
Get the progress as a percentage (0-100)
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
total → int
The total number of steps.
final

Methods

complete([String? completionMessage]) → void
Complete the progress bar
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
start() → void
Start the progress bar
stop() → void
Stop the progress bar without completing
tick([int amount = 1]) → void
Update the progress bar by incrementing the current value
toString() → String
A string representation of this object.
inherited
update(int value) → void
Set the progress bar to a specific value
updateMessage(String newMessage) → void
Update the message displayed alongside the progress bar

Operators

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