ErrorTracker

This class tracks errors and computes a summary of information like:

• where the errors happened
• what the error names are
• what the error codes are
• what is the general error message

This is extremely useful when there are dynamic error messages, such as argument validation.

Since the structure of the tracker.result object differs when using different options, it's typed as Record<string, unknown>. The most deep object has a count property, which is a number.

It's possible to get the total amount of errors via the tracker.total property.

Index

Constructors

• constructor

Properties

• errorSnapshotter
• result
• total

Methods

• add
• addAsync
• captureSnapshot
• getMostPopularErrors
• getUniqueErrorCount
• reset

Constructors

constructor

• new ErrorTracker(options?: Partial<ErrorTrackerOptions>): ErrorTracker

• Parameters

  • options: Partial<ErrorTrackerOptions> = {}

  Returns ErrorTracker

Properties

optionalerrorSnapshotter

errorSnapshotter?: ErrorSnapshotter

result

result: Record<string, unknown>

total

total: number

Methods

add

• add(error: ErrnoException): void

• Parameters

  • error: ErrnoException

  Returns void

addAsync

• addAsync(error: ErrnoException, context?: CrawlingContext<unknown, Dictionary>): Promise<void>

• This method is async, because it captures a snapshot of the error context. We added this new method to avoid breaking changes.

  ---

  Parameters

  • error: ErrnoException

  • optionalcontext: CrawlingContext<unknown, Dictionary>

  Returns Promise<void>

captureSnapshot

• captureSnapshot(storage: Record<string, unknown>, error: ErrnoException, context: CrawlingContext<unknown, Dictionary>): Promise<void>

• Parameters

  • storage: Record<string, unknown>

  • error: ErrnoException

  • context: CrawlingContext<unknown, Dictionary>

  Returns Promise<void>

getMostPopularErrors

• getMostPopularErrors(count: number): [number, string[]][]

• Parameters

  • count: number

  Returns [number, string[]][]

getUniqueErrorCount

• getUniqueErrorCount(): number

• Returns number

reset

• reset(): void

• Returns void