diff --git a/packages/core/src/types-hoist/options.ts b/packages/core/src/types-hoist/options.ts index 51ccc7cdab79..93f9be36ed25 100644 --- a/packages/core/src/types-hoist/options.ts +++ b/packages/core/src/types-hoist/options.ts @@ -12,45 +12,79 @@ import type { BaseTransportOptions, Transport } from './transport'; export interface ClientOptions { /** - * Enable debug functionality in the SDK itself + * Enable debug functionality in the SDK itself. If `debug` is set to `true` the SDK will attempt + * to print out useful debugging information about what the SDK is doing. + * + * @default false */ debug?: boolean; /** - * Specifies whether this SDK should send events to Sentry. - * Defaults to true. + * Specifies whether this SDK should send events to Sentry. Setting this to `enabled: false` + * doesn't prevent all overhead from Sentry instrumentation. To disable Sentry completely, + * depending on environment, call `Sentry.init conditionally. + * + * @default true */ enabled?: boolean; - /** Attaches stacktraces to pure capture message / log integrations */ + /** + * When enabled, stack traces are automatically attached to all events captured with `Sentry.captureMessage`. + * + * Grouping in Sentry is different for events with stack traces and without. As a result, you will get + * new groups as you enable or disable this flag for certain events. + * + * @default false + */ attachStacktrace?: boolean; /** - * Send SDK Client Reports. When calling `Sentry.init()`, this option defaults to `true`. + * Send SDK Client Reports, which are used to emit outcomes about events that the SDK dropped + * or failed to capture. + * + * @default true */ sendClientReports?: boolean; /** - * The Dsn used to connect to Sentry and identify the project. If omitted, the - * SDK will not send any data to Sentry. + * The DSN tells the SDK where to send the events. If this is not set, the SDK will not send any events to Sentry. + * + * @default undefined */ dsn?: string; /** - * The release identifier used when uploading respective source maps. Specify - * this value to allow Sentry to resolve the correct source maps when - * processing events. + * Sets the release. Release names are strings, but some formats are detected by Sentry and might be + * rendered differently. Learn more about how to send release data so Sentry can tell you about + * regressions between releases and identify the potential source in the + * [releases documentation](https://docs.sentry.io/product/releases/) + * + * @default undefined */ release?: string; - /** The current environment of your application (e.g. "production"). */ + /** + * The current environment of your application (e.g. "production"). + * + * Environments are case-sensitive. The environment name can't contain newlines, spaces or forward slashes, + * can't be the string "None", or exceed 64 characters. You can't delete environments, but you can hide them. + * + * @default "production" + */ environment?: string; - /** Sets the distribution for all events */ + /** + * Sets the distribution of the application. Distributions are used to disambiguate build or + * deployment variants of the same release of an application. + * + * @default undefined + */ dist?: string; /** * List of integrations that should be installed after SDK was initialized. + * + * @default [] */ integrations: Integration[]; @@ -61,8 +95,7 @@ export interface ClientOptions Transport; /** - * A stack parser implementation - * By default, a stack parser is supplied for all supported platforms + * A stack parser implementation. By default, a stack parser is supplied for all supported platforms. */ stackParser: StackParser; @@ -75,10 +108,12 @@ export interface ClientOptions; /** * A pattern for transaction names which should not be sent to Sentry. * By default, all transactions will be sent. + * + * Behavior of the `ignoreTransactions` option is controlled by the `Sentry.eventFiltersIntegration` integration. + * If the event filters integration is not installed, the `ignoreTransactions` option will not have any effect. + * + * @default [] */ ignoreTransactions?: Array; @@ -155,6 +212,8 @@ export interface ClientOptions; @@ -216,7 +284,10 @@ export interface ClientOptions; @@ -253,7 +324,7 @@ export interface ClientOptions