Interface GlobalConfiguration

The configuration shared by all validators. Changes apply to existing or new validators.

interface GlobalConfiguration {
    supportedTerminalEncodings(): Set<TerminalEncoding>;
    terminalEncoding(): TerminalEncoding;
    terminalEncoding(encoding: TerminalEncoding): GlobalConfiguration;
    terminalEncoding(
        encoding?: TerminalEncoding,
    ): GlobalConfiguration | TerminalEncoding;
}

Index

Methods

supportedTerminalEncodings terminalEncoding

Methods

supportedTerminalEncodings

supportedTerminalEncodings(): Set<TerminalEncoding>
Returns the encoding supported by the terminal.

Returns Set<TerminalEncoding>
the encoding supported by the terminal
- Defined in GlobalConfiguration.mts:17

terminalEncoding

terminalEncoding(): TerminalEncoding
Returns the current terminal encoding.

Returns TerminalEncoding
the current terminal encoding (defaults to the auto-detected encoding)
- Defined in GlobalConfiguration.mts:24
terminalEncoding(encoding: TerminalEncoding): GlobalConfiguration
Sets the terminal encoding of the output.

This can be used to force the use of ANSI colors when their support is not detected.
Parameters
- encoding: TerminalEncoding
  the type of encoding that the terminal supports
Returns GlobalConfiguration
this

Throws
TypeError if encoding is undefined or null
- Defined in GlobalConfiguration.mts:35
terminalEncoding(
encoding?: TerminalEncoding,
): GlobalConfiguration | TerminalEncoding
Parameters
- Optionalencoding: TerminalEncoding
Returns GlobalConfiguration | TerminalEncoding
- Defined in GlobalConfiguration.mts:37