@sentry/lynx-react
Version:
Official Sentry SDK for Lynx React
54 lines • 1.34 kB
TypeScript
import type { Client, Integration, Options } from '@sentry/core';
import type { LynxOptions } from './client';
/** Get the default integrations for the Lynx SDK. */
export declare function getDefaultIntegrations(_options: Options): Integration[];
/** Exported only for tests. */
export declare function applyDefaultOptions(optionsArg?: LynxOptions): LynxOptions;
/**
* The Sentry Lynx SDK Client.
*
* To use this SDK, call the {@link init} function as early as possible when
* loading the application. To set context information or send manual events, use
* the provided methods.
*
* @example
*
* ```
*
* import { init } from '@sentry/lynx-react';
*
* init({
* dsn: '__DSN__',
* // ...
* });
* ```
*
* @example
* ```
*
* import { addBreadcrumb } from '@sentry/lynx-react';
* addBreadcrumb({
* message: 'My Breadcrumb',
* // ...
* });
* ```
*
* @example
*
* ```
*
* import * as Sentry from '@sentry/lynx-react';
* Sentry.captureMessage('Hello, world!');
* Sentry.captureException(new Error('Good bye'));
* Sentry.captureEvent({
* message: 'Manual',
* stacktrace: [
* // ...
* ],
* });
* ```
*
* @see {@link LynxOptions} for documentation on configuration options.
*/
export declare function init(lynxOptions?: LynxOptions): Client | undefined;
//# sourceMappingURL=sdk.d.ts.map