Skip to content

Commit b09169e

Browse files
authored
fix(docs): Fix docstring for enabled option (#4052)
There is an SDK option, `enabled` (referring to the SDK as a whole), which we don't document other than including it in the types. In the types docstring, we currently claim that setting it to `false` will remove any SDK overhead, but this isn't entirely true. (See #4051 for more details). Whether or not this is ideal behavior is a larger question, but for the moment, this changes the docstring to match reality.
1 parent 7496f0a commit b09169e

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

packages/types/src/options.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ export interface Options {
1515
debug?: boolean;
1616

1717
/**
18-
* Specifies whether this SDK should activate and send events to Sentry.
19-
* Disabling the SDK reduces all overhead from instrumentation, collecting
20-
* breadcrumbs and capturing events. Defaults to true.
18+
* Specifies whether this SDK should send events to Sentry.
19+
* Defaults to true.
2120
*/
2221
enabled?: boolean;
2322

0 commit comments

Comments
 (0)