@sentry/browser

Variables

• chromeStackLineParser
• defaultIntegrations
• defaultStackLineParsers
• defaultStackParser
• geckoStackLineParser
• Integrations
• opera10StackLineParser
• opera11StackLineParser
• WINDOW
• winjsStackLineParser

Functions

• captureUserFeedback()
• close()
• createUserFeedbackEnvelope()
• eventFromException()
• eventFromMessage()
• flush()
• forceLoad()
• init()
• lastEventId()
• makeBrowserOfflineTransport()
• makeFetchTransport()
• makeXHRTransport()
• onLoad()
• onProfilingStartRouteTransaction()
• showReportDialog()
• wrap()

Classes

• Breadcrumbs

  • addSentryBreadcrumb()
  • id
  • name
  • options
  • setupOnce()
• BrowserClient

  • captureUserFeedback()
  • eventFromException()
  • eventFromMessage()
  • sendEvent()
• BrowserProfilingIntegration

  • handleGlobalEvent()
  • name
  • setupOnce()
• Dedupe

  • id
  • name
  • setupOnce()
• GlobalHandlers

  • id
  • name
  • setupOnce()
• HttpContext

  • id
  • name
  • setupOnce()
• LinkedErrors

  • id
  • name
  • setupOnce()
• TryCatch

  • id
  • name
  • setupOnce()

Interfaces

• ReportDialogOptions

  • dsn
  • errorFormEntry
  • errorGeneric
  • eventId
  • labelClose
  • labelComments
  • labelEmail
  • labelName
  • labelSubmit
  • lang
  • onLoad()
  • subtitle
  • subtitle2
  • successMessage
  • title
  • user

Type Aliases

• BrowserOptions

variable chromeStackLineParser

const chromeStackLineParser: StackLineParser;

variable defaultIntegrations

const defaultIntegrations: any[];

variable defaultStackLineParsers

const defaultStackLineParsers: StackLineParser[];

variable defaultStackParser

const defaultStackParser: any;

variable geckoStackLineParser

const geckoStackLineParser: StackLineParser;

variable Integrations

const Integrations: {
    GlobalHandlers: typeof BrowserIntegrations.GlobalHandlers;
    TryCatch: typeof BrowserIntegrations.TryCatch;
    Breadcrumbs: typeof BrowserIntegrations.Breadcrumbs;
    LinkedErrors: typeof BrowserIntegrations.LinkedErrors;
    HttpContext: typeof BrowserIntegrations.HttpContext;
    Dedupe: typeof BrowserIntegrations.Dedupe;
    FunctionToString: any;
    InboundFilters: any;
};

variable opera10StackLineParser

const opera10StackLineParser: StackLineParser;

variable opera11StackLineParser

const opera11StackLineParser: StackLineParser;

variable WINDOW

const WINDOW: any;

variable winjsStackLineParser

const winjsStackLineParser: StackLineParser;

function captureUserFeedback

captureUserFeedback: (feedback: UserFeedback) => void;

• Captures user feedback and sends it to Sentry.

function close

close: (timeout?: number) => PromiseLike<boolean>;

• Call close() on the current client, if there is one. See Client.close.

  Parameter timeout

  Maximum time in ms the client should wait to flush its event queue before shutting down. Omitting this parameter will cause the client to wait until all events are sent before disabling itself.

  Returns

  A promise which resolves to true if the queue successfully drains before the timeout, or false if it doesn't (or if there's no client defined).

function createUserFeedbackEnvelope

createUserFeedbackEnvelope: (
    feedback: UserFeedback,
    {
        metadata,
        tunnel,
        dsn,
    }: {
        metadata: SdkMetadata | undefined;
        tunnel: string | undefined;
        dsn: DsnComponents | undefined;
    }
) => EventEnvelope;

• Creates an envelope from a user feedback.

function eventFromException

eventFromException: (
    stackParser: StackParser,
    exception: unknown,
    hint?: EventHint,
    attachStacktrace?: boolean
) => PromiseLike<Event>;

• Creates an Event from all inputs to captureException and non-primitive inputs to captureMessage.

function eventFromMessage

eventFromMessage: (
    stackParser: StackParser,
    message: string,
    level?: Severity | SeverityLevel,
    hint?: EventHint,
    attachStacktrace?: boolean
) => PromiseLike<Event>;

• Builds and Event from a Message

function flush

flush: (timeout?: number) => PromiseLike<boolean>;

• Call flush() on the current client, if there is one. See Client.flush.

  Parameter timeout

  Maximum time in ms the client should wait to flush its event queue. Omitting this parameter will cause the client to wait until all events are sent before resolving the promise.

  Returns

  A promise which resolves to true if the queue successfully drains before the timeout, or false if it doesn't (or if there's no client defined).

function forceLoad

forceLoad: () => void;

• This function is here to be API compatible with the loader.

function init

init: (options?: BrowserOptions) => void;

• The Sentry Browser SDK Client.

  To use this SDK, call the init function as early as possible when loading the web page. To set context information or send manual events, use the provided methods.

  Example 1

  import { init } from '@sentry/browser';
  
  init({
    dsn: '__DSN__',
    // ...
  });

  Example 2

  import { configureScope } from '@sentry/browser';
  configureScope((scope: Scope) => {
    scope.setExtra({ battery: 0.7 });
    scope.setTag({ user_mode: 'admin' });
    scope.setUser({ id: '4711' });
  });

  Example 3

  import { addBreadcrumb } from '@sentry/browser';
  addBreadcrumb({
    message: 'My Breadcrumb',
    // ...
  });

  Example 4

  import * as Sentry from '@sentry/browser';
  Sentry.captureMessage('Hello, world!');
  Sentry.captureException(new Error('Good bye'));
  Sentry.captureEvent({
    message: 'Manual',
    stacktrace: [
      // ...
    ],
  });

  See Also

  • BrowserOptions for documentation on configuration options.

function lastEventId

lastEventId: () => string | undefined;

• This is the getter for lastEventId.

  Returns

  The last event id of a captured event.

function makeBrowserOfflineTransport

makeBrowserOfflineTransport: <T extends InternalBaseTransportOptions>(
    createTransport: (options: T) => Transport
) => (options: T & BrowserOfflineTransportOptions) => Transport;

• Creates a transport that uses IndexedDb to store events when offline.

function makeFetchTransport

makeFetchTransport: (
    options: BrowserTransportOptions,
    nativeFetch?: FetchImpl
) => Transport;

• Creates a Transport that uses the Fetch API to send events to Sentry.

function makeXHRTransport

makeXHRTransport: (options: BrowserTransportOptions) => Transport;

• Creates a Transport that uses the XMLHttpRequest API to send events to Sentry.

function onLoad

onLoad: (callback: () => void) => void;

• This function is here to be API compatible with the loader.

function onProfilingStartRouteTransaction

onProfilingStartRouteTransaction: (
    transaction: Transaction | undefined
) => Transaction | undefined;

• Safety wrapper for startTransaction for the unlikely case that transaction starts before tracing is imported - if that happens we want to avoid throwing an error from profiling code. see https://github.com/getsentry/sentry-javascript/issues/4731.

  Modifiers

  • @experimental

function showReportDialog

showReportDialog: (options?: ReportDialogOptions, hub?: Hub) => void;

• Present the user with a report dialog.

  Parameter options

  Everything is optional, we try to fetch all info need from the global scope.

function wrap

wrap: (fn: (...args: any) => any) => any;

• Wrap code within a try/catch block so the SDK is able to capture errors.

  Parameter fn

  A function to wrap.

  Returns

  The result of wrapped function call.

type BrowserOptions

type BrowserOptions = Options<BrowserTransportOptions> & BrowserClientReplayOptions;

• Configuration options for the Sentry Browser SDK.

  See Also

  • @sentry/types Options for more information.