@sentry/browser

Variables

• defaultIntegrations
• Integrations
• SDK_NAME

Functions

• close()
• eventFromException()
• eventFromMessage()
• flush()
• forceLoad()
• init()
• injectReportDialog()
• lastEventId()
• onLoad()
• showReportDialog()
• wrap()

Classes

• BrowserClient

  • showReportDialog()

Interfaces

• BrowserOptions

  • allowUrls
  • blacklistUrls
  • denyUrls
  • whitelistUrls
• ReportDialogOptions

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

Namespaces

• Transports

  • BaseTransport
  • FetchTransport
  • makeNewFetchTransport()
  • makeNewXHRTransport()
  • XHRTransport

variable defaultIntegrations

const defaultIntegrations: any[];

variable Integrations

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

variable SDK_NAME

const SDK_NAME: string;

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 eventFromException

eventFromException: (
    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: (
    message: string,
    level?: Severity,
    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 injectReportDialog

injectReportDialog: (options?: ReportDialogOptions) => void;

• Injects the Report Dialog script

function lastEventId

lastEventId: () => string | undefined;

• This is the getter for lastEventId.

  Returns

  The last event id of a captured event.

function onLoad

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

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

function showReportDialog

showReportDialog: (options?: ReportDialogOptions) => 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.