parro-it/libui-node

typescript support ?

sandangel opened this issue · 11 comments

sandangel commented

Could you consider adding typing for typescript support?

parro-it commented

I don't know typescript, but I happily accept a PR if you would mind.

sandangel commented

Sure, but I will have to investigate the API and architecture of this lib first. I can see the API in .js file is simple, but the API in the .cc files is pretty large. Could you please point me out the docs about the overall architecture? I think this docs will help other contributors too.

parro-it commented

You can start from here: https://github.com/parro-it/libui-node/blob/master/docs/readme.md
The first five links explain general concepts, while the others are for widgets.

Regarding architecture, we're experimenting with N-API: parro-it/libui-napi#11

parro-it commented

Oh I forgot, please base your work on branch 0_3_0. That will be the next release.

sandangel commented

Thanks. I will give it a try.

  • 🎉3
parro-it commented

@sandangel any news?

sandangel commented

@parro-it working on it. I think I will send a PR this weekend.

  • 🎉3
TomasHubelbauer commented

Thanks for working on this @sandangel, it will be very useful to me.

sandangel commented

@parro-it could you help by adding some JSDocs on public API like Size, Point... as well as on FontAttribute, OpenTypeFeatures ... methods?

  • 👍1
sandangel commented

hi @parro-it I have sent a PR but since I don't know C++ much, could you please preview if the return type is correct?

parro-it commented

Thank you @sandangel, I will review it today later...