Class Report

constructor

• new Report(origin: string, parent?: Report): Report

• Constructs a new report.

  Parameters

  • origin: string

    The ID of this report.
  • Optionalparent: Report

    The paren report for this report.

  Returns Report

  Throws

  InvalidOperationError When the origin was already used by another report in this hierarchy.

Readonlyorigin

store

• get store(): Map<string, ReportEntry[]>

• Retrieve the message store.

  Returns Map<string, ReportEntry[]>

  The message store.

aggregate

• aggregate(logger: BareLogger, depth?: number): void

• Prints the contents of the report.

  Parameters

  • logger: BareLogger

    A logger to use to print the report.
  • depth: number = 0

    How deep to indent this part of the report.

  Returns void

log

• log(message: string, context?: Record<string, unknown>): void

• Put an entry into the report.

  Parameters

  • message: string

    The message to add.
  • Optionalcontext: Record<string, unknown>

    An arbitrary key-value object to store with the message.

  Returns void