diff --git a/packages/core/src/types-hoist/options.ts b/packages/core/src/types-hoist/options.ts index 51ccc7cdab79..0401cf0f11e4 100644 --- a/packages/core/src/types-hoist/options.ts +++ b/packages/core/src/types-hoist/options.ts @@ -13,20 +13,25 @@ import type { BaseTransportOptions, Transport } from './transport'; export interface ClientOptions { /** * Enable debug functionality in the SDK itself + * @default false */ debug?: boolean; /** * Specifies whether this SDK should send events to Sentry. - * Defaults to true. + * @default true */ enabled?: boolean; - /** Attaches stacktraces to pure capture message / log integrations */ + /** + * Attaches stacktraces to pure capture message / log integrations + * @default false + */ attachStacktrace?: boolean; /** * Send SDK Client Reports. When calling `Sentry.init()`, this option defaults to `true`. + * @default true */ sendClientReports?: boolean; @@ -43,7 +48,10 @@ export interface ClientOptions; /** * A pattern for transaction names which should not be sent to Sentry. * By default, all transactions will be sent. + * @default [] */ ignoreTransactions?: Array; @@ -162,8 +178,7 @@ export interface ClientOptions; @@ -217,6 +234,7 @@ export interface ClientOptions;