Skip to content
This repository has been archived by the owner on Feb 23, 2023. It is now read-only.

How to make typescript difinition? #16

Closed
sergiy-oliynik opened this issue Feb 5, 2018 · 11 comments
Closed

How to make typescript difinition? #16

sergiy-oliynik opened this issue Feb 5, 2018 · 11 comments

Comments

@sergiy-oliynik
Copy link

Hi, bQvle. First of all thanks for good library. Currently i'm developing easy game with pixi-typescript and i would like to make ui with your tool. Can i generate typescript definition of your library? Thanks.

@bQvle
Copy link
Collaborator

bQvle commented Feb 12, 2018

Hi Sergiy,

I dont know if it can be done easy, I dont believe the docs is good enough to auto generate it. however @ivanpopelyshev is planning porting pixi-ui to typescript. When that's done further development will be in the typescript branch.

@ivanpopelyshev
Copy link

Yep, I have to defeat my laziness.

@apptaro
Copy link

apptaro commented Mar 26, 2018

@bQvle @ivanpopelyshev any updates on typescript version?

@ivanpopelyshev
Copy link

@apptaro we are working on official support of plugins for v5, though we dont have special column yet: https://github.com/pixijs/pixi.js/projects/6 , and all v5 plugins will have typings.

@englercj
Copy link
Member

englercj commented Mar 26, 2018

You can try this: https://github.com/englercj/tsd-jsdoc

It does require the jsdoc to be as correct as possible. If you encounter any incorrect typings, please report it :)

@apptaro
Copy link

apptaro commented Mar 28, 2018

I figured that even though I can use tsd-jsdoc, most of the jsdoc comment is not there, so d.ts created is not usable :(

@sbfkcel
Copy link

sbfkcel commented Nov 28, 2019

@apptaro I also feel very necessary

@teoxoy
Copy link

teoxoy commented Dec 11, 2019

@ivanpopelyshev I would like to offer to port the repo to typescript. Would this be welcome or should it be done by a pixi core contributor?

@ivanpopelyshev
Copy link

ivanpopelyshev commented Dec 11, 2019

Go for it. Another problem is that its old v4 repo and not v5. You can port it to TS first of course, v4 typings are fine. There'll be many "any" in webgl-related places.

@teoxoy
Copy link

teoxoy commented Dec 23, 2019

@ivanpopelyshev Since you mentioned a lot of types are missing from pixi v4, what would be better? Updating to pixi v5 first then converting the repo to typescript? Or the other way around?

@ShukantPal
Copy link
Member

Typescript conversion has been complete!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

8 participants