https://github.com/wartoshika/wow-declarations
Typescript declarations for the current live World of Warcraft Retail LUA API
https://github.com/wartoshika/wow-declarations
lua typescript typescript-declaration wow wow-declarations
Last synced: 3 months ago
JSON representation
Typescript declarations for the current live World of Warcraft Retail LUA API
- Host: GitHub
- URL: https://github.com/wartoshika/wow-declarations
- Owner: wartoshika
- License: mit
- Created: 2018-11-04T07:36:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T16:32:24.000Z (about 2 years ago)
- Last Synced: 2024-10-24T12:11:44.561Z (8 months ago)
- Topics: lua, typescript, typescript-declaration, wow, wow-declarations
- Homepage:
- Size: 321 KB
- Stars: 27
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/%40wartoshika%2Fwow-declarations)
[](https://travis-ci.org/wartoshika/wow-declarations)
# Typescript declarations for the current live World of Warcraft LUA API
> WoW Classic developers should use the [wow-classic-declarations](https://github.com/wartoshika/wow-classic-declarations) repository.
## Shadowland
Updates for the Shadowland expansion are currently in development. You can find a partial implementation on the master branch.
Once every function has been documented i will release it into a dedicated version.
**Supported transpilers for LUA targets**:
- qhun-transpiler ([GitHub-Page](https://github.com/wartoshika/qhun-transpiler))
- TypescriptToLua ([GitHub-Page](https://github.com/TypeScriptToLua/TypeScriptToLua)) - *Thanks to tstirrat*
## Setup
Installing this dependency via
- `$ npm install @wartoshika/[email protected]` (npm repository installation)
- `$ npm install wartoshika/wow-declarations#v8.3.0-release.1` (github repository installation)
> I strongly recommend to use a version tag when using github based install. Referencing the master branch can result in installing a breaking change. Github based installations need a prefixing `v` in the version number!
Please add the wow-declarations path to your `tsconfig.json` compiler options like below:
```js
{
"compilerOptions": {
// ...
"typeRoots": [
"./node_modules/@types",
"./node_modules/@wartoshika/wow-declarations"
]
}
}
```
## Changes
### **August 25 2022 - v9.0.5-release.2**
- Merging PR #18 (Cannot find name 'AtlasID')
### **June 16 2021 - v9.0.5-release.1**
- Merging PR #16 wich adds SlashCmdList
- Added a bunch of Shadowland related features
- Added declarations of common global tables like
- C_Item
- C_AdventureJournal
- C_EncounterJournal
- C_Loot
- C_LegendaryCrafting
- C_Soulbinds
- C_CovenantCallings
- C_AchivementInfo
- C_RaidLocks
- C_ItemInteraction
- C_ItemUpgrade
- C_Map
- C_NewItems
- Added common "mixin" functions like
- ItemLocation
### **Sat. 08 2020 - v8.3.0-release.1**
- Merging PR #11 wich add/remove functions that are present in the WoW API release 8.3.
**Breaking changes for classic addons**
- If you are using this dependency to develop WoW classic addons, make sure to use the dedicated repository [wow-classic-declarations](https://github.com/wartoshika/wow-classic-declarations). I think that this is a good decision since the two WoW versions may drifting apart.
### **Nov. 24 2019 - v8.2.5-release.2**
**Breaking changes** - Incomtabible with version `v8.2.5-release.1`
- Object declarations are now namespaced and can be imported into your file. (PR #10)
- I strongly recommend using npm packages with a fix version number or referencing the version tag when installing this dependency. See [setup](#Setup).
### **Oct. 5 2019 - v8.2.5-release.1**
- Version numbers now indicates wich WoW Addon api version is supported (closes #9)
## Contribution
If you want to contribute, please provide a pull request and ensure that you linted your changes with `npm run lint` or try to autofix the errors with `npm run lint:fix`. I appreciate your help!