Skip to content

Commit 8131751

Browse files
s1gr1dmydea
andauthored
docs(core): Fix docs for beforeSendSpan (#16129)
Docs follow-up for this PR: #14831 --------- Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
1 parent abdb73e commit 8131751

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

packages/core/src/types-hoist/options.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,15 +347,15 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
347347
beforeSend?: (event: ErrorEvent, hint: EventHint) => PromiseLike<ErrorEvent | null> | ErrorEvent | null;
348348

349349
/**
350-
* This function can be defined to modify or entirely drop a child span before it's sent.
350+
* This function can be defined to modify a child span before it's sent.
351351
* Returning `null` will cause this span to be dropped.
352352
*
353353
* Note that this function is only called for child spans and not for the root span (formerly known as transaction).
354354
* If you want to modify or drop the root span, use {@link Options.beforeSendTransaction} instead.
355355
*
356356
* @param span The span generated by the SDK.
357357
*
358-
* @returns A new span that will be sent or null if the span should not be sent.
358+
* @returns The modified span payload that will be sent.
359359
*/
360360
beforeSendSpan?: (span: SpanJSON) => SpanJSON;
361361

0 commit comments

Comments
 (0)