Class Terminal

The terminal associated with the process.

Index

Constructors

Methods

getEncoding getSupportedTypes setEncoding useBestEncoding

Constructors

constructor

new Terminal(): Terminal
Returns Terminal

Methods

getEncoding

getEncoding(): TerminalEncoding
Returns TerminalEncoding
the encoding that the terminal should use (defaults to the best available encoding)
- Defined in internal/validator/Terminal.mts:113

getSupportedTypes

getSupportedTypes(): Set<TerminalEncoding>
Returns Set<TerminalEncoding>
the encodings supported by the terminal
- Defined in internal/validator/Terminal.mts:21

setEncoding

setEncoding(encoding: TerminalEncoding): void
Indicates the type of encoding that the terminal should use.

This feature can be used to force the use of colors even when their support is not detected.
Parameters
- encoding: TerminalEncoding
  the type of encoding that the terminal should use
Returns void
Throws
TypeError if encoding is not a TerminalEncoding

See
Terminal.useBestEncoding
- Defined in internal/validator/Terminal.mts:93

useBestEncoding

useBestEncoding(): void
Indicates that validators should output the best encoding supported by the terminal.

Returns void
See
Terminal.setEncoding
- Defined in internal/validator/Terminal.mts:103