JSPM

  • Created
  • Published
  • Downloads 15285
  • Score
    100M100P100Q156732F
  • License SEE LICENSE IN LICENSE.md

Typescript types for the Dynatrace RUM JavaScript dtrum.* API

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dynatrace/dtrum-api-types) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    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.307.0

    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
    }