sentry-testkit/dist/types.d.ts

Sentry Testkit enables Sentry to work natively in your application while running tests. The report is not really sent but rather logged locally into memory. In this way, the logged reports can be fetched for your own verification or any other purpose in y

import { Event, Breadcrumb, User, SeverityLevel, Stacktrace, Transport, SpanAttributes } from '@sentry/core';
export = sentryTestkit;
declare function sentryTestkit<T extends sentryTestkit.V6TransportClass | sentryTestkit.V7TransportFunction>(): sentryTestkit.TestkitResult<T>;
declare namespace sentryTestkit {
    interface Page {
        on(event: string, handler: (...args: any[]) => any): void;
        off(event: string, handler: (...args: any[]) => any): void;
    }
    interface ReportError {
        name: string;
        message: string;
        stacktrace: Stacktrace;
    }
    interface Report {
        breadcrumbs: Breadcrumb[];
        error?: ReportError;
        message?: string;
        extra?: {
            [key: string]: any;
        };
        level: SeverityLevel;
        release?: string;
        user?: User;
        tags: {
            [key: string]: string;
        };
        originalReport: Event;
    }
    interface Span {
        id: string;
        span_id: string;
        op?: string;
        description?: string;
        parentSpanId: string;
        parent_span_id?: string;
        trace_id?: string;
    }
    interface Transaction {
        name: string;
        traceId: string;
        spanId: string;
        parentSpanId?: string | null;
        data?: Record<string, any>;
        status?: string | null;
        op?: string | null;
        release?: string;
        extra?: Record<string, any>;
        tags: Record<string, any>;
        attributes: SpanAttributes;
        spans: Span[];
    }
    interface Testkit {
        puppeteer: {
            startListening(page: Page, baseUrl?: string): void;
            stopListening(page: Page): void;
        };
        reports(): Report[];
        transactions(): Transaction[];
        reset(): void;
        getExceptionAt(index: number): ReportError | undefined;
        findReport(e: Error): Report | undefined;
        isExist(e: Error): boolean;
    }
    interface LocalServer {
        start: (dsn: string) => Promise<void>;
        stop: () => Promise<void>;
        getDsn: () => string;
    }
    type V6TransportClass = {
        new (): Transport;
    };
    type V7TransportFunction = () => Transport;
    interface TestkitResult<Transport extends V6TransportClass | V7TransportFunction> {
        testkit: Testkit;
        sentryTransport: Transport;
        initNetworkInterceptor<T>(dsn: string, initCallback: (baseUrl: string, handleRequestBody: (requestBody: {
            [key: string]: any;
        }) => void) => T): T;
        localServer: LocalServer;
    }
}
//# sourceMappingURL=types.d.ts.map