Class Task<T>

constructor

• new Task<T = unknown>(command: string, parser: Parser<T>): Task<T>

  Type Parameters

  • T = unknown

  Parameters

  • command: string

    is the value written to stdin to perform the given task.
  • parser: Parser<T>

    is used to parse resulting data from the underlying process to a typed object.

  Returns Task<T>

Readonlycommand

Readonlyparser

ReadonlytaskId

pending

• get pending(): boolean

  Returns boolean

promise

• get promise(): Promise<T>

  Returns Promise<T>

  the resolution or rejection of this task.

runtimeMs

• get runtimeMs(): undefined | number

  Returns undefined | number

state

• get state(): string

  Returns string

onStart

• onStart(opts: TaskOptions): void

  Parameters

  • opts: TaskOptions

  Returns void

onStderr

• onStderr(buf: string | Buffer<ArrayBufferLike>): void

  Parameters

  • buf: string | Buffer<ArrayBufferLike>

  Returns void

onStdout

• onStdout(buf: string | Buffer<ArrayBufferLike>): void

  Parameters

  • buf: string | Buffer<ArrayBufferLike>

  Returns void

reject

• reject(error: Error): boolean

  Parameters

  • error: Error

  Returns boolean

  true if the wrapped promise was rejected

toString

• toString(): string

  Returns string