Class TextStreamPrinter

Implements

ILoggerPrinter

Index

Constructors

Properties

Methods

clear close enqueueSpoolItem flush outputSpoolItem print

Constructors

constructor

new TextStreamPrinter(
    defaultStream: WriteStream | WriteStream,
    errorStream?: null | WriteStream | WriteStream,
    options?: TextStreamPrinterOptions,
): TextStreamPrinter
Parameters
- defaultStream: WriteStream | WriteStream
- errorStream: null | WriteStream | WriteStream = null
- Optionaloptions: TextStreamPrinterOptions
Returns TextStreamPrinter
- Defined in logger/printers/text-stream-printer.ts:41

Properties

`Protected` `Readonly`options

options: Required<TextStreamPrinterOptions>

Methods

clear

clear(): Promise<void>
If the printer is linked to a TTY, clear the console.

Returns Promise<void>
Implementation of ILoggerPrinter.clear
- Defined in logger/printers/text-stream-printer.ts:52

close

close(): Promise<void>
Close the printer and release any resources.

Returns Promise<void>
Implementation of ILoggerPrinter.close
- Defined in logger/printers/text-stream-printer.ts:62

`Protected`enqueueSpoolItem

enqueueSpoolItem(item: TextStreamPrinterSpoolItem): Promise<void>
Parameters
- item: TextStreamPrinterSpoolItem
Returns Promise<void>
- Defined in logger/printers/text-stream-printer.ts:98

flush

flush(): Promise<void>
Flush any buffered output.

Returns Promise<void>
Implementation of ILoggerPrinter.flush
- Defined in logger/printers/text-stream-printer.ts:66

`Protected`outputSpoolItem

outputSpoolItem(item: TextStreamPrinterSpoolItem): Promise<void>
Parameters
- item: TextStreamPrinterSpoolItem
Returns Promise<void>
- Defined in logger/printers/text-stream-printer.ts:108

print

print(record: LoggerRecord): Promise<void>
Print a log record.
Parameters
- record: LoggerRecord
  The log record to output
Returns Promise<void>
Implementation of ILoggerPrinter.print
- Defined in logger/printers/text-stream-printer.ts:90