@dynatrace/dtrum-api-types 1.237.2 → 1.239.1
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 +8 -14
- 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.239.1
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
> npm install --save-dev @dynatrace/dtrum-api-types
|
package/dtrum.d.ts
CHANGED
|
@@ -33,7 +33,8 @@ export interface APIPage {
|
|
|
33
33
|
group: string;
|
|
34
34
|
}
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
// ts-prune-ignore-next Ignored because it is not used, but should still show up in typedoc
|
|
37
|
+
export type PageLeaveListener = (unloadRunning: boolean) => void;
|
|
37
38
|
|
|
38
39
|
export type AllowedMapTypes = Date | string | number;
|
|
39
40
|
|
|
@@ -74,7 +75,7 @@ export interface PropertyObject {
|
|
|
74
75
|
}
|
|
75
76
|
|
|
76
77
|
export interface DtRumUserInput {
|
|
77
|
-
target
|
|
78
|
+
target: EventTarget | string | undefined;
|
|
78
79
|
name: string;
|
|
79
80
|
info: string;
|
|
80
81
|
title: string;
|
|
@@ -86,14 +87,14 @@ export interface DtRumUserInput {
|
|
|
86
87
|
export const enum ResourceSummaryTypes {
|
|
87
88
|
/** Stylesheet resource (e.g. .css) */
|
|
88
89
|
CSS = "c",
|
|
89
|
-
/**
|
|
90
|
-
|
|
90
|
+
/** Custom resource */
|
|
91
|
+
CUSTOM = "y",
|
|
91
92
|
/** Image resource (e.g. .jpg, .png) */
|
|
92
93
|
IMAGES = "i",
|
|
94
|
+
/** Undefined resource */
|
|
95
|
+
OTHER = "o",
|
|
93
96
|
/** Script resource (e.g. .js) */
|
|
94
|
-
SCRIPTS = "s"
|
|
95
|
-
/** Custom resource */
|
|
96
|
-
CUSTOM = "y"
|
|
97
|
+
SCRIPTS = "s"
|
|
97
98
|
}
|
|
98
99
|
|
|
99
100
|
/**
|
|
@@ -200,14 +201,12 @@ export interface DtrumApi {
|
|
|
200
201
|
* @see {@link actionName}
|
|
201
202
|
* @see {@link addActionProperties}
|
|
202
203
|
* @param listener A function that will be called when entering a new action
|
|
203
|
-
* @returns void
|
|
204
204
|
*/
|
|
205
205
|
addEnterActionListener(listener: ActionEnterListener): void;
|
|
206
206
|
/**
|
|
207
207
|
* Removes a previously attached listener that detects the enter action event
|
|
208
208
|
*
|
|
209
209
|
* @param listener The reference to the listener that needs to be removed
|
|
210
|
-
* @returns void
|
|
211
210
|
*/
|
|
212
211
|
removeEnterActionListener(listener: ActionEnterListener): void;
|
|
213
212
|
/**
|
|
@@ -233,14 +232,12 @@ export interface DtrumApi {
|
|
|
233
232
|
* @see {@link removeLeaveActionListener}
|
|
234
233
|
* @see {@link addActionProperties}
|
|
235
234
|
* @param listener A function that will be called when leaving an action
|
|
236
|
-
* @returns void
|
|
237
235
|
*/
|
|
238
236
|
addLeaveActionListener(listener: ActionLeaveListener): void;
|
|
239
237
|
/**
|
|
240
238
|
* Removes a previously attached listener that detects the leave action event
|
|
241
239
|
*
|
|
242
240
|
* @param listener A leave action listener to be removed
|
|
243
|
-
* @returns void
|
|
244
241
|
*/
|
|
245
242
|
removeLeaveActionListener(listener: ActionLeaveListener): void;
|
|
246
243
|
/**
|
|
@@ -262,9 +259,6 @@ export interface DtrumApi {
|
|
|
262
259
|
*
|
|
263
260
|
* Each key value pair must be defined in the following format 'key: { value: value<AllowedMapTypes>, public?: boolean }'
|
|
264
261
|
* Public property is optional and if not declared as true values will be sent as masked(dT_pv) in doNotTrack mode
|
|
265
|
-
* @returns Status report about properties that were passed to the function.
|
|
266
|
-
* It contains data about failed properties with the failure reason.
|
|
267
|
-
* Contains data about properties that were sent successfully and a general message with information about total failed properties.
|
|
268
262
|
*/
|
|
269
263
|
addActionProperties(parentActionId: number, javaLong?: PropertyMap<number>, date?: PropertyMap<Date>, shortString?: PropertyMap<string>, javaDouble?: PropertyMap<number>): void;
|
|
270
264
|
/**
|