UNPKG

1.3 kBTypeScriptView Raw
1import type { Event, Integration } from '@sentry/types';
2/** JSDoc */
3interface BreadcrumbsOptions {
4 console: boolean;
5 dom: boolean | {
6 serializeAttribute?: string | string[];
7 maxStringLength?: number;
8 };
9 fetch: boolean;
10 history: boolean;
11 sentry: boolean;
12 xhr: boolean;
13}
14export declare const BREADCRUMB_INTEGRATION_ID = "Breadcrumbs";
15/**
16 * Default Breadcrumbs instrumentations
17 * TODO: Deprecated - with v6, this will be renamed to `Instrument`
18 */
19export declare class Breadcrumbs implements Integration {
20 /**
21 * @inheritDoc
22 */
23 static id: string;
24 /**
25 * @inheritDoc
26 */
27 name: string;
28 /**
29 * Options of the breadcrumbs integration.
30 */
31 readonly options: Readonly<BreadcrumbsOptions>;
32 /**
33 * @inheritDoc
34 */
35 constructor(options?: Partial<BreadcrumbsOptions>);
36 /**
37 * Instrument browser built-ins w/ breadcrumb capturing
38 * - Console API
39 * - DOM API (click/typing)
40 * - XMLHttpRequest API
41 * - Fetch API
42 * - History API
43 */
44 setupOnce(): void;
45 /**
46 * Adds a breadcrumb for Sentry events or transactions if this option is enabled.
47 */
48 addSentryBreadcrumb(event: Event): void;
49}
50export {};
51//# sourceMappingURL=breadcrumbs.d.ts.map
\No newline at end of file