npm.io
1.343.4 • Published yesterday

@dynatrace/dtrum-api-types

Licence
SEE LICENSE IN LICENSE.md
Version
1.343.4
Deps
0
Size
33 kB
Vulns
0
Weekly
0

Dynatrace Dtrum Api Types

This package contains the Typescript type information for the dtrum.* API of the RUM Classic JavaScript.

Keep in mind that when the RUM Classic JavaScript is updated, this type package might not provide accurate types. Version: 1.343.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
}

Keywords