Interface SentryRequiredMethods

interface SentryRequiredMethods {
    addBreadcrumb: (
        breadcrumb: Breadcrumb,
        hint?: BreadcrumbHint,
    ) => ReturnType<Hub["addBreadcrumb"]>;
    captureException: (
        exception: any,
        hint?: ExclusiveEventHintOrCaptureContext,
    ) => string;
    captureMessage: (
        message: string,
        captureContext?: SeverityLevel | CaptureContext | Severity,
    ) => string;
}

Properties

addBreadcrumb captureException captureMessage

Properties

addBreadcrumb

addBreadcrumb: (
    breadcrumb: Breadcrumb,
    hint?: BreadcrumbHint,
) => ReturnType<Hub["addBreadcrumb"]>

Type declaration

    • (
          breadcrumb: Breadcrumb,
          hint?: BreadcrumbHint,
      ): ReturnType<Hub["addBreadcrumb"]>

    • Records a new breadcrumb which will be attached to future events.

      Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.

      Parameters

      • breadcrumb: Breadcrumb

        The breadcrumb to record.

      • Optionalhint: BreadcrumbHint

      Returns ReturnType<Hub["addBreadcrumb"]>

captureException

captureException: (
    exception: any,
    hint?: ExclusiveEventHintOrCaptureContext,
) => string

Type declaration

    • (exception: any, hint?: ExclusiveEventHintOrCaptureContext): string

    • Captures an exception event and sends it to Sentry.

      Parameters

      • exception: any

        The exception to capture.

      • Optionalhint: ExclusiveEventHintOrCaptureContext

        Optional additional data to attach to the Sentry event.

      Returns string

      the id of the captured Sentry event.

captureMessage

captureMessage: (
    message: string,
    captureContext?: SeverityLevel | CaptureContext | Severity,
) => string

Type declaration

    • (
          message: string,
          captureContext?: SeverityLevel | CaptureContext | Severity,
      ): string

    • Captures a message event and sends it to Sentry.

      Parameters

      • message: string
      • OptionalcaptureContext: SeverityLevel | CaptureContext | Severity

        Define the level of the message or pass in additional data to attach to the message.

      Returns string

      the id of the captured message.

Settings

Member Visibility

On This Page

Properties