Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Process

A process managed by the shell.

Hierarchy

  • Process

Index

Methods

exitCode

  • exitCode(): number
  • Returns number

getSession

  • Returns Session

getTty

  • getTty(): Tty
  • Returns Tty

interrupt

  • interrupt(): boolean
  • interrupt(completionHandler: ((res: void) => void) | Handler<void>): boolean
  • Attempt to interrupt the process.

    Returns boolean

  • Attempt to interrupt the process.

    Parameters

    • completionHandler: ((res: void) => void) | Handler<void>

    Returns boolean

resume

  • resume(): void
  • resume(foreground: boolean): void
  • resume(completionHandler: ((res: void) => void) | Handler<void>): void
  • resume(foreground: boolean, completionHandler: ((res: void) => void) | Handler<void>): void
  • Suspend the process.

    Returns void

  • Suspend the process.

    Parameters

    • foreground: boolean

    Returns void

  • Suspend the process.

    Parameters

    • completionHandler: ((res: void) => void) | Handler<void>

    Returns void

  • Suspend the process.

    Parameters

    • foreground: boolean
    • completionHandler: ((res: void) => void) | Handler<void>

    Returns void

run

  • run(): void
  • run(foregraound: boolean): void
  • Run the process.

    Returns void

  • Run the process.

    Parameters

    • foregraound: boolean

    Returns void

setSession

  • Set the process session

    Parameters

    Returns Process

setTty

  • Set the process tty.

    Parameters

    Returns Process

status

  • Returns ExecStatus

suspend

  • suspend(): void
  • suspend(completionHandler: ((res: void) => void) | Handler<void>): void
  • Resume the process.

    Returns void

  • Resume the process.

    Parameters

    • completionHandler: ((res: void) => void) | Handler<void>

    Returns void

terminate

  • terminate(): void
  • terminate(completionHandler: ((res: void) => void) | Handler<void>): void
  • Terminate the process.

    Returns void

  • Terminate the process.

    Parameters

    • completionHandler: ((res: void) => void) | Handler<void>

    Returns void

terminatedHandler

  • terminatedHandler(handler: ((res: number) => void) | Handler<number>): Process
  • Set an handler for being notified when the process terminates.

    Parameters

    • handler: ((res: number) => void) | Handler<number>

    Returns Process

toBackground

  • toBackground(): void
  • toBackground(completionHandler: ((res: void) => void) | Handler<void>): void
  • Set the process in background.

    Returns void

  • Set the process in background.

    Parameters

    • completionHandler: ((res: void) => void) | Handler<void>

    Returns void

toForeground

  • toForeground(): void
  • toForeground(completionHandler: ((res: void) => void) | Handler<void>): void
  • Set the process in foreground.

    Returns void

  • Set the process in foreground.

    Parameters

    • completionHandler: ((res: void) => void) | Handler<void>

    Returns void

Generated using TypeDoc