Console

Topics

Instance Properties

• activityBarWidth
• confirmOverride
  If set, all calls to confirm(_:) will use this value instead of asking the user.
• size
  The size of the Console window. Used for calculating lines printed and centering text.
• stylizedOutputOverride
  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.
• supportsANSICommands
  If the Console supports ANSI commands such as color and cursor movement.
• userInfo

Instance Methods

• ask(_:isSecure:)
  Requests input from the console after displaying a prompt.
• center(_:padding:)
  Centers a String according to this console’s size.
• choose(_:from:)
  Prompts the user to choose an item from the supplied array. The chosen item will be returned.
• choose(_:from:display:)
  Prompts the user to choose an item from the supplied array. The chosen item will be returned.
• clear(_:)
  Clears previously printed Console output according to the ConsoleClear type given.
• clear(lines:)
  Deletes lines that were previously printed to the terminal.
• confirm(_:)
  Requests yes / no confirmation from the user after a prompt.
• customActivity(title:titleAfterIndicator:frames:success:failure:)
  Creates an activity indicator with custom frames that are iterated over.
• customActivity(title:titleAfterIndicator:frames:success:failure:color:)
  Creates an activity indicator with custom frames that are iterated over.
• didOutputLines(count:)
  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.
• error(_:newLine:)
  Outputs a String to the Console with error style.
• info(_:newLine:)
  Outputs a String to the Console with info style.
• input()
  See input(isSecure:)
• input(isSecure:)
  Returns a String of input read from the Console until a line feed character was found.
• loadingBar(title:)
  Creates a new LoadingBar-based ActivityIndicator.
• output(_:)
  Outputs serialized ConsoleText to the Console.
• output(_:newLine:)
  Outputs serialized ConsoleText to the Console.
• output(_:style:newLine:)
  Outputs a String to the Console with the specified ConsoleStyle style.
• popEphemeral()
  Pops a previous ephemeral console state. All text outputted to the console immidiately after the last call to pushEphemeral() will be cleared.
• print(_:newLine:)
  Outputs a String to the Console with plain style.
• progressBar(title:)
  Creates a new ProgressBar-based ActivityIndicator.
• pushEphemeral()
  Pushes a new ephemeral console state. All text outputted to the console immidiately after this call can be cleared by using popEphemeral().
• report(error:newLine:)
  Outputs an error to the Console’s error stream.
• success(_:newLine:)
  Outputs a String to the Console with success style.
• warning(_:newLine:)
  Outputs a String to the Console with warning style.