Skip to content

Commit 0dccb9b

Browse files
committed
Clarify SegmentSpanCaptureConvertOptions doc comment
1 parent f25bf84 commit 0dccb9b

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

packages/core/src/tracing/segmentSpanCaptureStrategy.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ import type { TransactionEvent } from '../types/event';
55
import type { Span } from '../types/span';
66

77
/**
8-
* Optional hooks a deferring strategy passes when converting: skip spans already sent, record the ones
9-
* it sends (for orphan tracking). The synchronous default passes neither.
8+
* Callbacks the deferred-capture strategy hands to `_convertSpanToTransaction` when assembling a
9+
* transaction. The synchronous (browser) path calls the converter with no options, so neither runs.
1010
*/
1111
export interface SegmentSpanCaptureConvertOptions {
12+
/** Skip a descendant already sent in an earlier transaction, so it isn't sent twice. */
1213
isSpanAlreadyCaptured?: (span: Span) => boolean;
14+
/** Record each span included here, so a child that ends after the snapshot can be emitted as an orphan. */
1315
onSpanCaptured?: (span: Span) => void;
1416
}
1517

0 commit comments

Comments
 (0)