@wow-api/types

TypeScript declarations for the World of Warcraft API, designed for use with TypeScript to Lua (TSTL).

Install

npm install @wow-api/types

What's included

• Type declarations for WoW global API functions and C_ namespace methods
• Interface definitions for UI widget objects (Frame, Button, Texture, etc.)
• Core type aliases for WoW-specific primitives (GUID, UnitToken, fileID, etc.)
• JSDoc annotations with Lua signatures and links to the wiki documentation

All declarations use @noSelfInFile and @noSelf annotations, making them compatible with TSTL's calling conventions for Lua output.

Usage

Once installed, reference the types in your tsconfig.json:

{
  "compilerOptions": {
    "types": ["@wow-api/types"]
  }
}

Then use WoW API functions and types directly in your TypeScript code:

const name = UnitName("player");
const info = C_Item.GetItemInfo(19019);

License

MIT