Class RunDeadline

constructor

• new RunDeadline(budgetMs: number, now?: () => number): RunDeadline

  Start the budget now. now is the clock the budget is measured on; tests inject one that moves only when they move it.

  Parameters

  • budgetMs: number
  • now: () => number = Date.now

  Returns RunDeadline

  Throws

  when budgetMs is not a finite number, 0 or more.

ReadonlybudgetMs

notRun

• get notRun(): readonly string[]

  The steps the budget stopped, in the order they were stopped.

  Returns readonly string[]

expired

• expired(): boolean

  Whether the budget is spent. Records nothing.

  Returns boolean

issue

• issue(): ValidationIssue | undefined

  The finding for the steps the budget stopped, or undefined when every step ran: a budget spent by the last step still leaves a complete run.

  Returns ValidationIssue | undefined

reached

• reached(step: string): boolean

  Whether step must not start because the budget is spent. When it must not, step is recorded as not run.

  Parameters

  • step: string

  Returns boolean

record

• record(step: string): void

  Record step as not run, for a caller that already knows the budget is spent.

  Parameters

  • step: string

  Returns void

remainingMs

• remainingMs(): number

  Milliseconds left in the budget, never below zero.

  Returns number