Class PseudoPty

constructor

• new PseudoPty(): PseudoPty

  Returns PseudoPty

Readonlycols

handleFlowControl

ReadonlyonData

ReadonlyonExit

Readonlypid

Readonlyprocess

Readonlyrows

clear

• clear(): void

  Clears the pty's internal representation of its buffer. This is a no-op unless on Windows/ConPTY. This is useful if the buffer is cleared on the frontend in order to synchronize state with the backend to avoid ConPTY possibly reprinting the screen.

  Returns void

kill

• kill(signal?: string): void

  Kills the pty.

  Parameters

  • Optionalsignal: string

    The signal to use, defaults to SIGHUP. This parameter is not supported on Windows.

  Returns void

  Throws

  Will throw when signal is used on Windows.

on

• on(event: string, listener: (data: string) => void): void

  Parameters

  • event: string
  • listener: (data: string) => void

  Returns void

• on(event: string, listener: (exitCode: number, signal?: number) => void): void

  Parameters

  • event: string
  • listener: (exitCode: number, signal?: number) => void

  Returns void

• on(event: string, listener: (error?: string) => void): void

  Parameters

  • event: string
  • listener: (error?: string) => void

  Returns void

pause

• pause(): void

  Pauses the pty for customizable flow control.

  Returns void

resize

• resize(columns: number, rows: number): void

  Resizes the dimensions of the pty.

  Parameters

  • columns: number

    The number of columns to use.

  • rows: number

    The number of rows to use.

  Returns void

resume

• resume(): void

  Resumes the pty for customizable flow control.

  Returns void

write

• write(data: string): void

  Writes data to the pty.

  Parameters

  • data: string

    The data to write.

  Returns void