Topics

Instance Properties

• var activityBarWidth: Int
• var confirmOverride: Bool?
  If set, all calls to confirm(_:) will use this value instead of asking the user.
• var size: (width: Int, height: Int)
  The size of the Console window. Used for calculating lines printed and centering text.
• var stylizedOutputOverride: Bool?
  If set, overrides a Terminal’s own determination as to whether its output supports color commands. Useful for easily implementing an option of the form --color=no|yes|auto. If the active Console is not specifically a Terminal, has no effect.
• var supportsANSICommands: Bool
  If the Console supports ANSI commands such as color and cursor movement.
• var userInfo: [AnySendableHashable : any Sendable]

Instance Methods

• func ask(ConsoleText, isSecure: Bool) -> String
  Requests input from the console after displaying a prompt.
• func center(_:padding:)
  Centers a String according to this console’s size.
• func choose<T>(ConsoleText, from: [T]) -> T
  Prompts the user to choose an item from the supplied array. The chosen item will be returned.
• func choose<T>(ConsoleText, from: [T], display: (T) -> ConsoleText) -> T
  Prompts the user to choose an item from the supplied array. The chosen item will be returned.
• func clear(ConsoleClear)
  Clears previously printed Console output according to the ConsoleClear type given.
• func clear(lines: Int)
  Deletes lines that were previously printed to the terminal.
• func confirm(ConsoleText) -> Bool
  Requests yes / no confirmation from the user after a prompt.
• func customActivity(frames: [ConsoleText], success: String, failure: String) -> ActivityIndicator<CustomActivity>
  Creates an activity indicator with custom frames that are iterated over.
• func customActivity(frames: [String], success: String, failure: String, color: ConsoleColor) -> ActivityIndicator<CustomActivity>
  Creates an activity indicator with custom frames that are iterated over.
• func didOutputLines(count: Int)
  This method allows the Console implementation to record how many lines have been printed so that pushEphemeral() and popEphemeral() knows how many lines to clear.
• func error(String, newLine: Bool)
  Outputs a String to the Console with ConsoleStyle.error style.
• func info(String, newLine: Bool)
  Outputs a String to the Console with ConsoleStyle.info style.
• func input() -> String
  See Console.input(isSecure:)
• func input(isSecure: Bool) -> String
  Returns a String of input read from the Console until a line feed character was found.
• func loadingBar(title: String, targetQueue: DispatchQueue?) -> ActivityIndicator<LoadingBar>
  Creates a new LoadingBar-based ActivityIndicator.
• func output(ConsoleText)
  Outputs serialized ConsoleText to the Console.
• func output(ConsoleText, newLine: Bool)
  Outputs serialized ConsoleText to the Console.
• func output(String, style: ConsoleStyle, newLine: Bool)
  Outputs a String to the Console with the specified ConsoleStyle style.
• func popEphemeral()
  Pops a previous ephemeral console state. All text outputted to the console immidiately after the last call to pushEphemeral() will be cleared.
• func print(String, newLine: Bool)
  Outputs a String to the Console with ConsoleStyle.plain style.
• func progressBar(title: String, targetQueue: DispatchQueue?) -> ActivityIndicator<ProgressBar>
  Creates a new ProgressBar-based ActivityIndicator.
• func pushEphemeral()
  Pushes a new ephemeral console state. All text outputted to the console immidiately after this call can be cleared by using popEphemeral().
• func report(error: String, newLine: Bool)
  Outputs an error to the Console’s error stream.
• func success(String, newLine: Bool)
  Outputs a String to the Console with ConsoleStyle.success style.
• func wait(seconds: Double)
  Blocks the current thread for the specified number of seconds.
• func warning(String, newLine: Bool)
  Outputs a String to the Console with ConsoleStyle.warning style.