@dynatrace/dtrum-api-types 1.225.8 → 1.233.5
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/README.md +1 -1
- package/dtrum.d.ts +9 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
This package contains the Typescript type information for the Dtrum Api of the javascript agent.
|
|
3
3
|
|
|
4
4
|
Keep in mind that when the javascript agent is updated, this type package might not provide accurate types.
|
|
5
|
-
Version: 1.
|
|
5
|
+
Version: 1.233.5
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
> npm install --save-dev @dynatrace/dtrum-api-types
|
package/dtrum.d.ts
CHANGED
|
@@ -33,7 +33,7 @@ export interface APIPage {
|
|
|
33
33
|
group: string;
|
|
34
34
|
}
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
type PageLeaveListener = (unloadRunning: boolean) => void;
|
|
37
37
|
|
|
38
38
|
export type AllowedMapTypes = Date | string | number;
|
|
39
39
|
|
|
@@ -159,7 +159,7 @@ export interface DtrumApi {
|
|
|
159
159
|
/**
|
|
160
160
|
* Force signal sending to make sure that actions aren't lost (e.g., use before a window unload event).
|
|
161
161
|
*
|
|
162
|
-
* @deprecated Use {@link sendBeacon} instead. We will
|
|
162
|
+
* @deprecated Use {@link sendBeacon} instead. We will remove "sendSignal" in June 2022.
|
|
163
163
|
* @see {@link sendBeacon}
|
|
164
164
|
* @param forceSync Force synchronous sending of signal (if false, it'll be sent asynchronously)
|
|
165
165
|
* @param sendPreview Force sending of preview signals which haven't been closed yet.
|
|
@@ -183,13 +183,12 @@ export interface DtrumApi {
|
|
|
183
183
|
* @see {@link leaveAction}
|
|
184
184
|
* @param actionName Name of the action
|
|
185
185
|
* @param actionType Type of the action (e.g., can be 'click', 'load', 'KD',...) -
|
|
186
|
-
* DEPRECATED: not used any more, will be removed in
|
|
186
|
+
* DEPRECATED: not used any more, will be removed in June 2022.
|
|
187
187
|
* @param startTime Timestamp in milliseconds. if null, current time is used.
|
|
188
188
|
* @param sourceUrl Source url for the action
|
|
189
|
-
* @param sourceTitle Source title for the action
|
|
190
189
|
* @returns ID of the created action
|
|
191
190
|
*/
|
|
192
|
-
"enterAction"(actionName: string, actionType
|
|
191
|
+
"enterAction"(actionName: string, actionType?: string, startTime?: number, sourceUrl?: string): number;
|
|
193
192
|
/**
|
|
194
193
|
* Attaches a listener that gets called while entering an action <br />
|
|
195
194
|
* Remove the listener if not needed or make sure to filter actions if using {@link addActionProperties},
|
|
@@ -281,7 +280,7 @@ export interface DtrumApi {
|
|
|
281
280
|
* 'file', 'line', 'column', and 'stack'. The 'message' property must be provided; all other values are optional.
|
|
282
281
|
* @param parentActionId parent action id. if not passed or null, error is added to current action
|
|
283
282
|
*/
|
|
284
|
-
reportError(error: Error, parentActionId?: number): void;
|
|
283
|
+
reportError(error: Error | string, parentActionId?: number): void;
|
|
285
284
|
/**
|
|
286
285
|
* Sets the {@link https://www.dynatrace.com/support/help/shortlink/user-tagging#user-tagging-via-javascript-api | user tag}.
|
|
287
286
|
* Use to identify individual users across different browsers, devices, and user sessions.
|
|
@@ -293,7 +292,7 @@ export interface DtrumApi {
|
|
|
293
292
|
* Indicates the start of a third party resource
|
|
294
293
|
*
|
|
295
294
|
* @deprecated Since modern browsers already provide resource timings, including for third parties,
|
|
296
|
-
* we will
|
|
295
|
+
* we will remove this function in June 2022.
|
|
297
296
|
* @param type 'i'...image, 's'...script, 'c'... custom
|
|
298
297
|
* @param url Complete URL of resource
|
|
299
298
|
*/
|
|
@@ -302,7 +301,7 @@ export interface DtrumApi {
|
|
|
302
301
|
* Indicates the stop of a third party resource
|
|
303
302
|
*
|
|
304
303
|
* @deprecated Since modern browsers already provide resource timings, including for third parties,
|
|
305
|
-
* we will
|
|
304
|
+
* we will remove this function in June 2022.
|
|
306
305
|
* @param url Complete URL of resource (must match URL provided in startThirdParty)
|
|
307
306
|
* @param success True if the resource was loaded successfully, false if not
|
|
308
307
|
* @param start Absolute start time in milliseconds. Optional. When parameter is not passed or <=0,
|
|
@@ -325,13 +324,13 @@ export interface DtrumApi {
|
|
|
325
324
|
* Use when a user input is not automatically detected by the RUM monitoring code.
|
|
326
325
|
*
|
|
327
326
|
* @see {@link endUserInput}
|
|
328
|
-
* @param domNode DOM node which triggered the action (button, etc) is used for determining its caption
|
|
327
|
+
* @param domNode DOM node which triggered the action (button, etc) or a string is used for determining its caption
|
|
329
328
|
* @param type Type of action: 'click', 'keypress', 'scroll',...
|
|
330
329
|
* @param addInfo Additional info for user input such as key, mouse button, etc ('F5', 'RETURN',...)
|
|
331
330
|
* @param validTime How long this userInput should be valid(in ms)
|
|
332
331
|
* @returns An object containing all the information about the userInput
|
|
333
332
|
*/
|
|
334
|
-
beginUserInput(domNode: HTMLElement, type: string, addInfo
|
|
333
|
+
beginUserInput(domNode: HTMLElement | string, type: string, addInfo?: string, validTime?: number): DtRumUserInput;
|
|
335
334
|
/**
|
|
336
335
|
* Ends a user input.
|
|
337
336
|
*
|