Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Pty

Represents a PTY.

Hierarchy

  • Pty

Index

Properties

Methods

Properties

onAvailableWriteBufferSizeChange

onAvailableWriteBufferSizeChange: Event<BufferSizeChange>

onData

onData: Event<string>

onExit

onExit: Event<void>

Methods

destroy

  • destroy(): void

  • Destroy the pty and shut down the attached process

    Returns void

getAvailableWriteBufferSize

  • getAvailableWriteBufferSize(): number

getWorkingDirectory

  • getWorkingDirectory(): Promise<string | null>

  • Get the working directory of the process on the other side of this PTY.

    Returns Promise<string | null>

    The working directory or null if it could not be determined.

permittedDataSize

  • permittedDataSize(size: number): void

  • Parameters

    • size: number

    Returns void

resize

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

  • Tell the pty that the size of the terminal has changed

    Parameters

    • cols: number

      number of columns in ther terminal.

    • rows: number

      number of rows in the terminal.

    Returns void

write

  • write(data: string): void

  • Write data to the pty

    Parameters

    • data: string

      data to write.

    Returns void

Generated using TypeDoc