@dynatrace/dtrum-api-types 1.305.2 → 1.309.4

package/LICENSE.md

@@ -0,0 +1 @@
+Copyright (c) Dynatrace LLC. All rights reserved.

package/README.md

@@ -1,44 +1,44 @@
-# Dynatrace Dtrum Api Types
-This package contains the Typescript type information for the Dtrum Api of the javascript agent.
-
-Keep in mind that when the javascript agent is updated, this type package might not provide accurate types.
-Version: 1.305.2
-
-## Installation
-> npm install --save-dev @dynatrace/dtrum-api-types
-
-## Configuration
-Make sure to add these paths to `"typeRoots"` in tsconfig.json under `"compilerOptions"`
-```
-"typeRoots": ["./node_modules/@types", "./node_modules/@dynatrace/"],
-```
-
-## Usage examples
-Type inference works out of the box for dtrum calls.
-```
-if (window.dtrum) {
-    window.dtrum.identifyUser("exampleId");
-} else {
-    // handle missing dtrum api
-}
-```
-
-In case some specific types or enums are needed, you can import them from `dtrum` types library.
-```
-import { ActionNameResult } from '@dynatrace/dtrum-api-types';
-
-if (window.dtrum) {
-    const result = window.dtrum.actionName("exampleName");
-    switch(result) {
-      case ActionNameResult.SUCCESS:
-      // handle success...
-      break;
-      case ActionNameResult.ACTION_NOT_FOUND:
-      // handle action not found...
-      break;
-      //etc...
-    }
-} else {
-    // handle missing dtrum api
-}
-```
+# Dynatrace Dtrum Api Types
+This package contains the Typescript type information for the dtrum.* API of the RUM JavaScript.
+
+Keep in mind that when the RUM JavaScript is updated, this type package might not provide accurate types.
+Version: 1.309.4
+
+## Installation
+> npm install --save-dev @dynatrace/dtrum-api-types
+
+## Configuration
+Make sure to add these paths to `"typeRoots"` in tsconfig.json under `"compilerOptions"`
+```
+"typeRoots": ["./node_modules/@types", "./node_modules/@dynatrace/"],
+```
+
+## Usage examples
+Type inference works out of the box for dtrum calls.
+```
+if (window.dtrum) {
+    window.dtrum.identifyUser("exampleId");
+} else {
+    // handle missing dtrum api
+}
+```
+
+In case some specific types or enums are needed, you can import them from `dtrum` types library.
+```
+import { ActionNameResult } from '@dynatrace/dtrum-api-types';
+
+if (window.dtrum) {
+    const result = window.dtrum.actionName("exampleName");
+    switch(result) {
+      case ActionNameResult.SUCCESS:
+      // handle success...
+      break;
+      case ActionNameResult.ACTION_NOT_FOUND:
+      // handle action not found...
+      break;
+      //etc...
+    }
+} else {
+    // handle missing dtrum api
+}
+```

package/dtrum.d.ts

@@ -141,7 +141,6 @@ export interface MetaData {
     info?: string;
 }
 
-
 export interface DtrumApi {
     /**
      * Enables/disables automatic action detection. Use when you want to instrument your application only manually.
@@ -530,9 +529,9 @@ export interface DtrumApi {
      * @param key           The key of the error. For example, 'validation error'
      * @param value         The error value. For example, 'Email validation failed'
      * @param hint          A hint to pinpoint the problem, e.g. content of the input element which triggered the failed validation
-     * @param parentingInfo How the custom error should be attached (default = false),
-     *                      [case number]: To which open action the custom error event should be attached,
-     *                      [case boolean]: If true it will get attached to the current active action
+     * @param parentingInfo How the custom error should be attached (default = false).
+     *                      When providing a number: To which open action the custom error event should be attached.
+     *                      When providing a boolean: If true it will get attached to the current active action
      */
     reportCustomError(key: string, value: string, hint?: string, parentingInfo?: number | boolean): void;
 

package/package.json

@@ -1,18 +1,18 @@
-{
-    "name": "@dynatrace/dtrum-api-types",
-    "version": "1.305.2",
-    "description": "Typescript types for Dynatrace jsagents dtrum api.",
-    "main": "",
-    "typings": "dtrum.d.ts",
-    "homepage": "https://www.dynatrace.com",
-    "author": "Dynatrace",
-    "license": "Copyright (c) Dynatrace LLC. All rights reserved.",
-    "keywords": [
-        "dynatrace",
-        "jsagent",
-        "dtrum",
-        "api",
-        "typescript",
-        "types"
-    ]
-}
+{
+    "name": "@dynatrace/dtrum-api-types",
+    "version": "1.309.4",
+    "description": "Typescript types for the Dynatrace RUM JavaScript dtrum.* API",
+    "main": "",
+    "typings": "dtrum.d.ts",
+    "homepage": "https://www.dynatrace.com",
+    "author": "Dynatrace",
+    "license": "SEE LICENSE IN LICENSE.md",
+    "keywords": [
+        "dynatrace",
+        "jsagent",
+        "dtrum",
+        "api",
+        "typescript",
+        "types"
+    ]
+}