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(): number | undefined

  Returns number | undefined

state

• get state(): string

  Returns string

timeoutElapsedMs

• get timeoutElapsedMs(): number | undefined

  Time since this task started, or since its last timeout reset.

  Returns number | undefined

onStart

• onStart(
      opts: TaskOptions,
      beforeParse?: () => void,
      resetTimeout?: () => boolean,
  ): void

  Called by BatchProcess when this task starts. Overrides must pass every argument to super.onStart(), or Task.resetTimeout stops working.

  Parameters

  • opts: TaskOptions
  • OptionalbeforeParse: () => void
  • OptionalresetTimeout: () => boolean

  Returns void

onStderr

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

  Called with this task's stderr. Non-blank stderr is logged at warn, so a subclass that removes lines it understands before calling super.onStderr() keeps those lines out of the log.

  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

resetTimeout

• resetTimeout(): boolean

  Restart this task's timeout. Call this only after verifying that the task made progress: output alone is not progress.

  Returns boolean

  false if the task isn't running or has no timeout, and for startup and health-check tasks.

toString

• toString(): string

  Returns string