Class ANSIMode

request

CSI Pa $ p
Copy

CSI ? Pa $ p
Copy

reset

CSI Pd ; ... ; Pd l
Copy

CSI ? Pd ; ... ; Pd l
Copy

set

CSI Pd ; ... ; Pd h
Copy

CSI ? Pd ; ... ; Pd h
Copy

Readonlyvalue

report

• report<S extends ModeSetting>(setting: S): string

  Report mode (DECRPM) sequence that the terminal sends to the host in response to this mode request DECRQM.

  ANSI format:

  CSI Pa ; Ps ; $ y
  Copy

  DEC format:

  CSI ? Pa ; Ps $ y
  Copy

  Where Pa is the mode number, and Ps is the mode value.

  • 0: Not recognized
  • 1: Set
  • 2: Reset
  • 3: Permanent set
  • 4: Permanent reset

  Type Parameters

  • S extends ModeSetting

  Parameters

  • setting: S

    the mode setting

  Returns string

  escape sequence

  See

  https://vt100.net/docs/vt510-rm/DECRPM.html

StaticisNotRecognized

• isNotRecognized(setting: ModeSetting): boolean

  Returns true if the mode setting is not recognized.

  Parameters

  • setting: ModeSetting

  Returns boolean

StaticisPermanentlyReset

• isPermanentlyReset(setting: ModeSetting): boolean

  Returns true if the mode setting is permanently reset.

  Parameters

  • setting: ModeSetting

  Returns boolean

StaticisPermanentlySet

• isPermanentlySet(setting: ModeSetting): boolean

  Returns true if the mode setting is permanently set.

  Parameters

  • setting: ModeSetting

  Returns boolean

StaticisReset

• isReset(setting: ModeSetting): boolean

  Returns true if the mode setting is reset or permanently reset.

  Parameters

  • setting: ModeSetting

  Returns boolean

StaticisSet

• isSet(setting: ModeSetting): boolean

  Returns true if the mode setting is set or permanently set.

  Parameters

  • setting: ModeSetting

  Returns boolean

Staticmatch

• match(sequence: string): ModeSetting

  Match mode setting from a report mode (DECRPM) sequence.

  Parameters

  • sequence: string

    report mode sequence

  Returns ModeSetting

  mode setting

Staticreport

• report(mode: Mode, setting: ModeSetting): string

  Report mode (DECRPM) returns a sequence that the terminal sends to the host in response to a mode request DECRQM.

  ANSI format:

  CSI Pa ; Ps ; $ y
  Copy

  DEC format:

  CSI ? Pa ; Ps $ y
  Copy

  Where Pa is the mode number, and Ps is the mode value.

  • 0: Not recognized
  • 1: Set
  • 2: Reset
  • 3: Permanent set
  • 4: Permanent reset

  Parameters

  • mode: Mode
  • setting: ModeSetting

  Returns string

  See

  https://vt100.net/docs/vt510-rm/DECRPM.html

Staticrequest

• request<T extends number>(mode: Mode): `[${T}$p` | `[?${T}$p`

  Request mode (DECRQM) returns a sequence to request a mode from the terminal. The terminal responds with a report mode function DECRPM.

  ANSI format:

  CSI Pa $ p
  Copy

  DEC format:

  CSI ? Pa $ p
  Copy

  Type Parameters

  • T extends number

  Parameters

  • mode: Mode

  Returns `[${T}$p` | `[?${T}$p`

  See

  https://vt100.net/docs/vt510-rm/DECRQM.html

Staticreset

• reset(...modes: Mode[]): "" | `[${string}l` | `[?${string}l`

  Reset mode (RM) returns a sequence to reset a mode. The mode arguments are a list of modes to reset.

  If one of the modes is a DECMode, the function will return two escape sequences.

  ANSI format:

  CSI Pd ; ... ; Pd l
  Copy

  DEC format:

  CSI ? Pd ; ... ; Pd l
  Copy

  Parameters

  • ...modes: Mode[]

  Returns "" | `[${string}l` | `[?${string}l`

  See

  https://vt100.net/docs/vt510-rm/RM.html

Staticset

• set(...modes: Mode[]): `[${string}h` | `[?${string}h`

  Set mode (SM) returns a sequence to set a mode. The mode arguments are a list of modes to set.

  If one of the modes is a DECMode, the function will return two escape sequences.

  ANSI format:

  CSI Pd ; ... ; Pd h
  Copy

  DEC format:

  CSI ? Pd ; ... ; Pd h
  Copy

  Parameters

  • ...modes: Mode[]

  Returns `[${string}h` | `[?${string}h`

  See

  https://vt100.net/docs/vt510-rm/SM.html

Staticsetting

• setting(value: string | number): ModeSetting

  Parse mode setting from number or string.

  Parameters

  • value: string | number

    the value to parse

  Returns ModeSetting

  mode setting