@sentry/types 8.14.0 → 8.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/types/client.d.ts +29 -14
- package/build/types/client.d.ts.map +1 -1
- package/build/types-ts3.8/client.d.ts +29 -14
- package/package.json +1 -1
package/build/types/client.d.ts
CHANGED
|
@@ -155,11 +155,13 @@ export interface Client<O extends ClientOptions = ClientOptions> {
|
|
|
155
155
|
/**
|
|
156
156
|
* Register a callback for whenever a span is started.
|
|
157
157
|
* Receives the span as argument.
|
|
158
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
158
159
|
*/
|
|
159
|
-
on(hook: 'spanStart', callback: (span: Span) => void): void;
|
|
160
|
+
on(hook: 'spanStart', callback: (span: Span) => void): () => void;
|
|
160
161
|
/**
|
|
161
162
|
* Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
|
|
162
163
|
* property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
|
|
164
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
163
165
|
*/
|
|
164
166
|
on(hook: 'beforeSampling', callback: (samplingData: {
|
|
165
167
|
spanAttributes: SpanAttributes;
|
|
@@ -172,67 +174,80 @@ export interface Client<O extends ClientOptions = ClientOptions> {
|
|
|
172
174
|
/**
|
|
173
175
|
* Register a callback for whenever a span is ended.
|
|
174
176
|
* Receives the span as argument.
|
|
177
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
175
178
|
*/
|
|
176
|
-
on(hook: 'spanEnd', callback: (span: Span) => void): void;
|
|
179
|
+
on(hook: 'spanEnd', callback: (span: Span) => void): () => void;
|
|
177
180
|
/**
|
|
178
181
|
* Register a callback for when an idle span is allowed to auto-finish.
|
|
182
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
179
183
|
*/
|
|
180
|
-
on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
|
|
184
|
+
on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;
|
|
181
185
|
/**
|
|
182
186
|
* Register a callback for transaction start and finish.
|
|
187
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
183
188
|
*/
|
|
184
|
-
on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
|
|
189
|
+
on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;
|
|
185
190
|
/**
|
|
186
191
|
* Register a callback for before sending an event.
|
|
187
192
|
* This is called right before an event is sent and should not be used to mutate the event.
|
|
188
193
|
* Receives an Event & EventHint as arguments.
|
|
194
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
189
195
|
*/
|
|
190
|
-
on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
|
|
196
|
+
on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;
|
|
191
197
|
/**
|
|
192
198
|
* Register a callback for preprocessing an event,
|
|
193
199
|
* before it is passed to (global) event processors.
|
|
194
200
|
* Receives an Event & EventHint as arguments.
|
|
201
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
195
202
|
*/
|
|
196
|
-
on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
|
|
203
|
+
on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;
|
|
197
204
|
/**
|
|
198
205
|
* Register a callback for when an event has been sent.
|
|
206
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
199
207
|
*/
|
|
200
|
-
on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
|
|
208
|
+
on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;
|
|
201
209
|
/**
|
|
202
210
|
* Register a callback before a breadcrumb is added.
|
|
211
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
203
212
|
*/
|
|
204
|
-
on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
|
|
213
|
+
on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;
|
|
205
214
|
/**
|
|
206
215
|
* Register a callback when a DSC (Dynamic Sampling Context) is created.
|
|
216
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
207
217
|
*/
|
|
208
|
-
on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
|
|
218
|
+
on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;
|
|
209
219
|
/**
|
|
210
220
|
* Register a callback when a Feedback event has been prepared.
|
|
211
221
|
* This should be used to mutate the event. The options argument can hint
|
|
212
222
|
* about what kind of mutation it expects.
|
|
223
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
213
224
|
*/
|
|
214
225
|
on(hook: 'beforeSendFeedback', callback: (feedback: FeedbackEvent, options?: {
|
|
215
226
|
includeReplay?: boolean;
|
|
216
|
-
}) => void): void;
|
|
227
|
+
}) => void): () => void;
|
|
217
228
|
/**
|
|
218
229
|
* A hook for the browser tracing integrations to trigger a span start for a page load.
|
|
230
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
219
231
|
*/
|
|
220
232
|
on(hook: 'startPageLoadSpan', callback: (options: StartSpanOptions, traceOptions?: {
|
|
221
233
|
sentryTrace?: string | undefined;
|
|
222
234
|
baggage?: string | undefined;
|
|
223
|
-
}) => void): void;
|
|
235
|
+
}) => void): () => void;
|
|
224
236
|
/**
|
|
225
237
|
* A hook for browser tracing integrations to trigger a span for a navigation.
|
|
238
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
226
239
|
*/
|
|
227
|
-
on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
|
|
240
|
+
on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;
|
|
228
241
|
/**
|
|
229
242
|
* A hook that is called when the client is flushing
|
|
243
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
230
244
|
*/
|
|
231
|
-
on(hook: 'flush', callback: () => void): void;
|
|
245
|
+
on(hook: 'flush', callback: () => void): () => void;
|
|
232
246
|
/**
|
|
233
247
|
* A hook that is called when the client is closing
|
|
248
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
234
249
|
*/
|
|
235
|
-
on(hook: 'close', callback: () => void): void;
|
|
250
|
+
on(hook: 'close', callback: () => void): () => void;
|
|
236
251
|
/** Fire a hook whener a span starts. */
|
|
237
252
|
emit(hook: 'spanStart', span: Span): void;
|
|
238
253
|
/** A hook that is called every time before a span is sampled. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnE,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAE3E;;;;;;;;GAQG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa;IAC7D;;;;;;;;;OASG;IACH,gBAAgB,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEjF;;;;;;;;;;OAUG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEvG;;;;;;;;;OASG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3E;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvC;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAExF,+BAA+B;IAC/B,MAAM,IAAI,aAAa,GAAG,SAAS,CAAC;IAEpC,mCAAmC;IACnC,UAAU,IAAI,CAAC,CAAC;IAEhB;;;OAGG;IACH,cAAc,IAAI,WAAW,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,IAAI,SAAS,GAAG,SAAS,CAAC;IAEtC;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,iBAAiB,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,kBAAkB,IAAI,cAAc,EAAE,CAAC;IAEvC,8FAA8F;IAC9F,oBAAoB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEvF;;;;;;SAMK;IACL,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAE/C;;;OAGG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb,mHAAmH;IACnH,kBAAkB,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAEzE,0EAA0E;IAC1E,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,EAAE,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAE5G,kCAAkC;IAClC,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAEhD,oCAAoC;IACpC,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAExD,kCAAkC;IAClC,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAAC,4BAA4B,CAAC,CAAC;IAE5E;;;;;;OAMG;IACH,kBAAkB,CAAC,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IAK7F
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnE,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAE3E;;;;;;;;GAQG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa;IAC7D;;;;;;;;;OASG;IACH,gBAAgB,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEjF;;;;;;;;;;OAUG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEvG;;;;;;;;;OASG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3E;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvC;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAExF,+BAA+B;IAC/B,MAAM,IAAI,aAAa,GAAG,SAAS,CAAC;IAEpC,mCAAmC;IACnC,UAAU,IAAI,CAAC,CAAC;IAEhB;;;OAGG;IACH,cAAc,IAAI,WAAW,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,IAAI,SAAS,GAAG,SAAS,CAAC;IAEtC;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9C;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,iBAAiB,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,kBAAkB,IAAI,cAAc,EAAE,CAAC;IAEvC,8FAA8F;IAC9F,oBAAoB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEvF;;;;;;SAMK;IACL,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAE/C;;;OAGG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb,mHAAmH;IACnH,kBAAkB,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAEzE,0EAA0E;IAC1E,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,EAAE,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAE5G,kCAAkC;IAClC,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAEhD,oCAAoC;IACpC,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAExD,kCAAkC;IAClC,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAAC,4BAA4B,CAAC,CAAC;IAE5E;;;;;;OAMG;IACH,kBAAkB,CAAC,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IAK7F;;;;OAIG;IACH,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAElE;;;;OAIG;IACH,EAAE,CACA,IAAI,EAAE,gBAAgB,EACtB,QAAQ,EAAE,CACR,YAAY,EAAE;QACZ,cAAc,EAAE,cAAc,CAAC;QAC/B,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,aAAa,CAAC,EAAE,eAAe,CAAC;KACjC,EACD,gBAAgB,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,KACpC,IAAI,GACR,IAAI,CAAC;IAER;;;;OAIG;IACH,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAEhE;;;OAGG;IACH,EAAE,CAAC,IAAI,EAAE,0BAA0B,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAEjF;;;OAGG;IACH,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAE/E;;;;;OAKG;IACH,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAExG;;;;;OAKG;IACH,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAExG;;;OAGG;IACH,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,4BAA4B,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAErH;;;OAGG;IACH,EAAE,CAAC,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,cAAc,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAE/G;;;OAGG;IACH,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,sBAAsB,EAAE,QAAQ,CAAC,EAAE,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAEpG;;;;;OAKG;IACH,EAAE,CACA,IAAI,EAAE,oBAAoB,EAC1B,QAAQ,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,GACjF,MAAM,IAAI,CAAC;IAEd;;;OAGG;IACH,EAAE,CACA,IAAI,EAAE,mBAAmB,EACzB,QAAQ,EAAE,CACR,OAAO,EAAE,gBAAgB,EACzB,YAAY,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,KAC9E,IAAI,GACR,MAAM,IAAI,CAAC;IAEd;;;OAGG;IACH,EAAE,CAAC,IAAI,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAE3F;;;OAGG;IACH,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;IAEpD;;;OAGG;IACH,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;IAEpD,wCAAwC;IACxC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAE1C,iEAAiE;IACjE,IAAI,CACF,IAAI,EAAE,gBAAgB,EACtB,YAAY,EAAE;QACZ,cAAc,EAAE,cAAc,CAAC;QAC/B,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,aAAa,CAAC,EAAE,eAAe,CAAC;KACjC,EACD,gBAAgB,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,GACtC,IAAI,CAAC;IAER,sCAAsC;IACtC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,0BAA0B,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAMzD,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEvD;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAEpE;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAMpE,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE7F;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAEvF;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,sBAAsB,EAAE,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAE5E;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,oBAAoB,EAAE,QAAQ,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEvG;;OAEG;IACH,IAAI,CACF,IAAI,EAAE,mBAAmB,EACzB,OAAO,EAAE,gBAAgB,EACzB,YAAY,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAChF,IAAI,CAAC;IAER;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;CAG3B"}
|
|
@@ -155,11 +155,13 @@ export interface Client<O extends ClientOptions = ClientOptions> {
|
|
|
155
155
|
/**
|
|
156
156
|
* Register a callback for whenever a span is started.
|
|
157
157
|
* Receives the span as argument.
|
|
158
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
158
159
|
*/
|
|
159
|
-
on(hook: 'spanStart', callback: (span: Span) => void): void;
|
|
160
|
+
on(hook: 'spanStart', callback: (span: Span) => void): () => void;
|
|
160
161
|
/**
|
|
161
162
|
* Register a callback before span sampling runs. Receives a `samplingDecision` object argument with a `decision`
|
|
162
163
|
* property that can be used to make a sampling decision that will be enforced, before any span sampling runs.
|
|
164
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
163
165
|
*/
|
|
164
166
|
on(hook: 'beforeSampling', callback: (samplingData: {
|
|
165
167
|
spanAttributes: SpanAttributes;
|
|
@@ -172,67 +174,80 @@ export interface Client<O extends ClientOptions = ClientOptions> {
|
|
|
172
174
|
/**
|
|
173
175
|
* Register a callback for whenever a span is ended.
|
|
174
176
|
* Receives the span as argument.
|
|
177
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
175
178
|
*/
|
|
176
|
-
on(hook: 'spanEnd', callback: (span: Span) => void): void;
|
|
179
|
+
on(hook: 'spanEnd', callback: (span: Span) => void): () => void;
|
|
177
180
|
/**
|
|
178
181
|
* Register a callback for when an idle span is allowed to auto-finish.
|
|
182
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
179
183
|
*/
|
|
180
|
-
on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): void;
|
|
184
|
+
on(hook: 'idleSpanEnableAutoFinish', callback: (span: Span) => void): () => void;
|
|
181
185
|
/**
|
|
182
186
|
* Register a callback for transaction start and finish.
|
|
187
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
183
188
|
*/
|
|
184
|
-
on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): void;
|
|
189
|
+
on(hook: 'beforeEnvelope', callback: (envelope: Envelope) => void): () => void;
|
|
185
190
|
/**
|
|
186
191
|
* Register a callback for before sending an event.
|
|
187
192
|
* This is called right before an event is sent and should not be used to mutate the event.
|
|
188
193
|
* Receives an Event & EventHint as arguments.
|
|
194
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
189
195
|
*/
|
|
190
|
-
on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
|
|
196
|
+
on(hook: 'beforeSendEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;
|
|
191
197
|
/**
|
|
192
198
|
* Register a callback for preprocessing an event,
|
|
193
199
|
* before it is passed to (global) event processors.
|
|
194
200
|
* Receives an Event & EventHint as arguments.
|
|
201
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
195
202
|
*/
|
|
196
|
-
on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): void;
|
|
203
|
+
on(hook: 'preprocessEvent', callback: (event: Event, hint?: EventHint | undefined) => void): () => void;
|
|
197
204
|
/**
|
|
198
205
|
* Register a callback for when an event has been sent.
|
|
206
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
199
207
|
*/
|
|
200
|
-
on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): void;
|
|
208
|
+
on(hook: 'afterSendEvent', callback: (event: Event, sendResponse: TransportMakeRequestResponse) => void): () => void;
|
|
201
209
|
/**
|
|
202
210
|
* Register a callback before a breadcrumb is added.
|
|
211
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
203
212
|
*/
|
|
204
|
-
on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): void;
|
|
213
|
+
on(hook: 'beforeAddBreadcrumb', callback: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void): () => void;
|
|
205
214
|
/**
|
|
206
215
|
* Register a callback when a DSC (Dynamic Sampling Context) is created.
|
|
216
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
207
217
|
*/
|
|
208
|
-
on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): void;
|
|
218
|
+
on(hook: 'createDsc', callback: (dsc: DynamicSamplingContext, rootSpan?: Span) => void): () => void;
|
|
209
219
|
/**
|
|
210
220
|
* Register a callback when a Feedback event has been prepared.
|
|
211
221
|
* This should be used to mutate the event. The options argument can hint
|
|
212
222
|
* about what kind of mutation it expects.
|
|
223
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
213
224
|
*/
|
|
214
225
|
on(hook: 'beforeSendFeedback', callback: (feedback: FeedbackEvent, options?: {
|
|
215
226
|
includeReplay?: boolean;
|
|
216
|
-
}) => void): void;
|
|
227
|
+
}) => void): () => void;
|
|
217
228
|
/**
|
|
218
229
|
* A hook for the browser tracing integrations to trigger a span start for a page load.
|
|
230
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
219
231
|
*/
|
|
220
232
|
on(hook: 'startPageLoadSpan', callback: (options: StartSpanOptions, traceOptions?: {
|
|
221
233
|
sentryTrace?: string | undefined;
|
|
222
234
|
baggage?: string | undefined;
|
|
223
|
-
}) => void): void;
|
|
235
|
+
}) => void): () => void;
|
|
224
236
|
/**
|
|
225
237
|
* A hook for browser tracing integrations to trigger a span for a navigation.
|
|
238
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
226
239
|
*/
|
|
227
|
-
on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): void;
|
|
240
|
+
on(hook: 'startNavigationSpan', callback: (options: StartSpanOptions) => void): () => void;
|
|
228
241
|
/**
|
|
229
242
|
* A hook that is called when the client is flushing
|
|
243
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
230
244
|
*/
|
|
231
|
-
on(hook: 'flush', callback: () => void): void;
|
|
245
|
+
on(hook: 'flush', callback: () => void): () => void;
|
|
232
246
|
/**
|
|
233
247
|
* A hook that is called when the client is closing
|
|
248
|
+
* @returns A function that, when executed, removes the registered callback.
|
|
234
249
|
*/
|
|
235
|
-
on(hook: 'close', callback: () => void): void;
|
|
250
|
+
on(hook: 'close', callback: () => void): () => void;
|
|
236
251
|
/** Fire a hook whener a span starts. */
|
|
237
252
|
emit(hook: 'spanStart', span: Span): void;
|
|
238
253
|
/** A hook that is called every time before a span is sampled. */
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sentry/types",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.15.0",
|
|
4
4
|
"description": "Types for all Sentry JavaScript SDKs",
|
|
5
5
|
"repository": "git://github.com/getsentry/sentry-javascript.git",
|
|
6
6
|
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/types",
|