@sentry/types - npm Package Compare versions

Comparing version 8.14.0 to 8.15.0

build/types-ts3.8/client.d.ts

@@ -158,7 +158,9 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
      * Receives the span as argument.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'spanStart', callback: (span: Span) => void): void;
+    on(hook: 'spanStart', callback: (span: Span) => void): () => void;
     /**
      * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
      * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
+     * @returns A function that, when executed, removes the registered callback.
      */
@@ -176,12 +178,15 @@ on(hook: 'beforeSampling', callback: (samplingData: {
      * Receives the span as argument.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'spanEnd', callback: (span: Span) => void): void;
+    on(hook: 'spanEnd', callback: (span: Span) => void): () => void;
     /**
      * Register a callback for when an idle span is allowed to auto-finish.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
+    on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;
     /**
      * Register a callback for transaction start and finish.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
+    on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;
     /**
@@ -191,4 +196,5 @@ * Register a callback for before sending an event.
      * Receives an Event & EventHint as arguments.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
+    on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;
     /**
@@ -198,16 +204,20 @@ * Register a callback for preprocessing an event,
      * Receives an Event & EventHint as arguments.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
+    on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;
     /**
      * Register a callback for when an event has been sent.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
+    on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;
     /**
      * Register a callback before a breadcrumb is added.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
+    on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;
     /**
      * Register a callback when a DSC (Dynamic Sampling Context) is created.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
+    on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;
     /**
@@ -217,8 +227,10 @@ * Register a callback when a Feedback event has been prepared.
      * about what kind of mutation it expects.
+     * @returns A function that, when executed, removes the registered callback.
      */
     on(hook: 'beforeSendFeedback', callback: (feedback: FeedbackEvent, options?: {
         includeReplay?: boolean;
-    }) => void): void;
+    }) => void): () => void;
     /**
      * A hook for the browser tracing integrations to trigger a span start for a page load.
+     * @returns A function that, when executed, removes the registered callback.
      */
@@ -228,15 +240,18 @@ on(hook: 'startPageLoadSpan', callback: (options: StartSpanOptions, traceOptions?: {
         baggage?: string | undefined;
-    }) => void): void;
+    }) => void): () => void;
     /**
      * A hook for browser tracing integrations to trigger a span for a navigation.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
+    on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;
     /**
      * A hook that is called when the client is flushing
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'flush', callback: () => void): void;
+    on(hook: 'flush', callback: () => void): () => void;
     /**
      * A hook that is called when the client is closing
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'close', callback: () => void): void;
+    on(hook: 'close', callback: () => void): () => void;
     /** Fire a hook whener a span starts. */
@@ -243,0 +258,0 @@ emit(hook: 'spanStart', span: Span): void;

build/types/client.d.ts

@@ -158,7 +158,9 @@ import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
      * Receives the span as argument.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'spanStart', callback: (span: Span) => void): void;
+    on(hook: 'spanStart', callback: (span: Span) => void): () => void;
     /**
      * Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
      * property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
+     * @returns A function that, when executed, removes the registered callback.
      */
@@ -176,12 +178,15 @@ on(hook: 'beforeSampling', callback: (samplingData: {
      * Receives the span as argument.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'spanEnd', callback: (span: Span) => void): void;
+    on(hook: 'spanEnd', callback: (span: Span) => void): () => void;
     /**
      * Register a callback for when an idle span is allowed to auto-finish.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
+    on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;
     /**
      * Register a callback for transaction start and finish.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
+    on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;
     /**
@@ -191,4 +196,5 @@ * Register a callback for before sending an event.
      * Receives an Event & EventHint as arguments.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
+    on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;
     /**
@@ -198,16 +204,20 @@ * Register a callback for preprocessing an event,
      * Receives an Event & EventHint as arguments.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
+    on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;
     /**
      * Register a callback for when an event has been sent.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
+    on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;
     /**
      * Register a callback before a breadcrumb is added.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
+    on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;
     /**
      * Register a callback when a DSC (Dynamic Sampling Context) is created.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
+    on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;
     /**
@@ -217,8 +227,10 @@ * Register a callback when a Feedback event has been prepared.
      * about what kind of mutation it expects.
+     * @returns A function that, when executed, removes the registered callback.
      */
     on(hook: 'beforeSendFeedback', callback: (feedback: FeedbackEvent, options?: {
         includeReplay?: boolean;
-    }) => void): void;
+    }) => void): () => void;
     /**
      * A hook for the browser tracing integrations to trigger a span start for a page load.
+     * @returns A function that, when executed, removes the registered callback.
      */
@@ -228,15 +240,18 @@ on(hook: 'startPageLoadSpan', callback: (options: StartSpanOptions, traceOptions?: {
         baggage?: string | undefined;
-    }) => void): void;
+    }) => void): () => void;
     /**
      * A hook for browser tracing integrations to trigger a span for a navigation.
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
+    on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;
     /**
      * A hook that is called when the client is flushing
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'flush', callback: () => void): void;
+    on(hook: 'flush', callback: () => void): () => void;
     /**
      * A hook that is called when the client is closing
+     * @returns A function that, when executed, removes the registered callback.
      */
-    on(hook: 'close', callback: () => void): void;
+    on(hook: 'close', callback: () => void): () => void;
     /** Fire a hook whener a span starts. */
@@ -243,0 +258,0 @@ emit(hook: 'spanStart', span: Span): void;

package.json

 {
   "name": "@sentry/types",
-  "version": "8.14.0",
+  "version": "8.15.0",
   "description": "Types for all Sentry JavaScript SDKs",
@@ -5,0 +5,0 @@ "repository": "git://github.com/getsentry/sentry-javascript.git",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

326212

increased by0.83%

Lines of code

6707

increased by0.45%

No dependency changes