Interface which defines a breadcrumb.

Hierarchy

  • Breadcrumb

Properties

The class of the breadcrumb. This is the top level categorization of breadcrumbs.

Any data associated with the breadcrumb.

The level of severity of the breadcrumb. The default choice of level should be info if there isn't a clear reason to use a different level.

message?: string

A message associated with the breadcrumb.

timestamp: number

When the event associated with the breadcrumb happened. The timestamp is in milliseconds since January 1, 1970 Universal Coordinated Time (UTC)

For most breadcrumbs this will not be different than the time of breadcrumb creation, but if there is a delay between the event and breadcrumb capture, then the time of the event should be used instead.

type?: string

The type of the breadcrumb. Each class may be split into multiple types with the type more specifically categorizing the type of event.

Generated using TypeDoc