Class Writer

A helper class for writing formatted strings.

Hierarchy

Writer
- OsColorWriter
- WebColorWriter

Implements

IWriter

Index

Constructors

constructor

Properties

buffer
color

Methods

Constructors

constructor

new Writer(): Writer

Returns Writer

Properties

Protected buffer

buffer: string = ""

Protected color

color: ColorState = ...

Methods

bg

bg(color: ColorType): void

Implementation of IWriter.bg
- Defined in writer.ts:73
Sets the background color.

Parameters
- color: ColorType
  
  New color.
Returns void

clear

clear(): void

Implementation of IWriter.clear
- Defined in writer.ts:95
Clears the internal buffer but keeps the current colors.

Returns void

fg

fg(color: ColorType): void

Implementation of IWriter.fg
- Defined in writer.ts:66
Sets the foreground color.

Parameters
- color: ColorType
  
  New color.
Returns void

print

print(): void

Implementation of IWriter.print
- Defined in writer.ts:91
Prints the formatted content of this writer in the console.

Returns void

push

push(str: string): void

Implementation of IWriter.push
- Defined in writer.ts:59
Writes a string to the internal buffer.

Parameters
- str: string
  
  String to write.
Returns void

Protected pushColor

pushColor(): void

- Defined in writer.ts:56
Writes a color marker to the internal buffer.

virtual

Returns void

resetColor

resetColor(fg?: boolean, bg?: boolean): void

Implementation of IWriter.resetColor
- Defined in writer.ts:80
Resets the current color to the default.

Parameters
- Optional fg: boolean
  
  Foreground color.
- Optional bg: boolean
  
  Background color.
Returns void

toString

toString(): string

Implementation of IWriter.toString
- Defined in writer.ts:101
Returns string

Generated using TypeDoc