{"id":13342315,"url":"https://github.com/wartoshika/wow-declarations","last_synced_at":"2025-03-12T00:31:16.611Z","repository":{"id":44917763,"uuid":"156059722","full_name":"wartoshika/wow-declarations","owner":"wartoshika","description":"Typescript declarations for the current live World of Warcraft Retail LUA API","archived":false,"fork":false,"pushed_at":"2023-05-01T16:32:24.000Z","size":329,"stargazers_count":27,"open_issues_count":0,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-24T12:11:44.561Z","etag":null,"topics":["lua","typescript","typescript-declaration","wow","wow-declarations"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wartoshika.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-04T07:36:31.000Z","updated_at":"2024-08-12T19:35:06.000Z","dependencies_parsed_at":"2024-10-24T05:40:17.839Z","dependency_job_id":null,"html_url":"https://github.com/wartoshika/wow-declarations","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wartoshika%2Fwow-declarations","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wartoshika%2Fwow-declarations/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wartoshika%2Fwow-declarations/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wartoshika%2Fwow-declarations/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wartoshika","download_url":"https://codeload.github.com/wartoshika/wow-declarations/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243136265,"owners_count":20241987,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lua","typescript","typescript-declaration","wow","wow-declarations"],"created_at":"2024-07-29T19:28:56.696Z","updated_at":"2025-03-12T00:31:15.950Z","avatar_url":"https://github.com/wartoshika.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm version](https://badge.fury.io/js/%40wartoshika%2Fwow-declarations.svg)](https://badge.fury.io/js/%40wartoshika%2Fwow-declarations)\n[![Build Status](https://travis-ci.org/wartoshika/wow-declarations.svg?branch=master)](https://travis-ci.org/wartoshika/wow-declarations)\n\n# Typescript declarations for the current live World of Warcraft LUA API\n\n\u003e WoW Classic developers should use the [wow-classic-declarations](https://github.com/wartoshika/wow-classic-declarations) repository.\n\n## Shadowland\n\nUpdates for the Shadowland expansion are currently in development. You can find a partial implementation on the master branch.\nOnce every function has been documented i will release it into a dedicated version.\n\n**Supported transpilers for LUA targets**:\n- qhun-transpiler ([GitHub-Page](https://github.com/wartoshika/qhun-transpiler))\n- TypescriptToLua ([GitHub-Page](https://github.com/TypeScriptToLua/TypeScriptToLua)) - *Thanks to tstirrat*\n\n## Setup\n\nInstalling this dependency via\n\n- `$ npm install @wartoshika/wow-declarations@8.3.0-release.1` (npm repository installation)\n- `$ npm install wartoshika/wow-declarations#v8.3.0-release.1` (github repository installation)\n\n\u003e 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!\n\nPlease add the wow-declarations path to your `tsconfig.json` compiler options like below:\n\n```js\n{\n    \"compilerOptions\": {\n        // ...\n        \"typeRoots\": [\n            \"./node_modules/@types\",\n            \"./node_modules/@wartoshika/wow-declarations\"\n        ]\n    }\n}\n```\n\n## Changes\n\n### **August 25 2022 - v9.0.5-release.2**\n\n- Merging PR #18 (Cannot find name 'AtlasID')\n\n### **June 16 2021 - v9.0.5-release.1**\n\n- Merging PR #16 wich adds SlashCmdList\n- Added a bunch of Shadowland related features\n- Added declarations of common global tables like\n   - C_Item\n   - C_AdventureJournal \n   - C_EncounterJournal \n   - C_Loot\n   - C_LegendaryCrafting\n   - C_Soulbinds\n   - C_CovenantCallings\n   - C_AchivementInfo \n   - C_RaidLocks \n   - C_ItemInteraction \n   - C_ItemUpgrade \n   - C_Map \n   - C_NewItems\n- Added common \"mixin\" functions like\n   - ItemLocation\n\n### **Sat. 08 2020 - v8.3.0-release.1**\n\n- Merging PR #11 wich add/remove functions that are present in the WoW API release 8.3.\n\n**Breaking changes for classic addons**\n\n- 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.\n\n### **Nov. 24 2019 - v8.2.5-release.2**\n\n**Breaking changes** - Incomtabible with version `v8.2.5-release.1`\n\n- Object declarations are now namespaced and can be imported into your file. (PR #10)\n- I strongly recommend using npm packages with a fix version number or referencing the version tag when installing this dependency. See [setup](#Setup).\n\n### **Oct. 5 2019 - v8.2.5-release.1**\n\n- Version numbers now indicates wich WoW Addon api version is supported (closes #9)\n\n## Contribution\n\nIf 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!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwartoshika%2Fwow-declarations","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwartoshika%2Fwow-declarations","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwartoshika%2Fwow-declarations/lists"}