Panorama Types

TypeScript definitions for Dota 2 Panorama API

Installation

Check out our addon template for usage examples.

1. Get package from npm

yarn add -D @moddota/panorama-types
# or
npm install -D @moddota/panorama-types

2. Modify your tsconfig.json

{
  "compilerOptions": {
    "types": ["@moddota/panorama-types"]
  }
}

Enums

This package includes 2 versions of enum types - raw and normalized. Raw types are included by default, with "types": ["@moddota/panorama-types"]. They match actual values available at runtime, however lead to repetition and require you to use inconsistent standard names.

Normalized enum types can be included with "types": ["@moddota/panorama-types/normalized"] and require you to use @moddota/panorama-types/transformer (for example using ttypescript). With these types, enums have consistent names and have no repeated parts. For example, instead of EDOTA_ModifyGold_Reason.DOTA_ModifyGold_Unspecified you have to write ModifyGoldReason.UNSPECIFIED.

Both type versions define aliases for alternative names, so libraries created with one version would be compatible with a different one.