Provide typings

[hirako2000]

Typescript developers would benefit in having typings for whs. There are already some typings for three.js.
See best practice to write type definitions.

Version:

• v2.x.x
• v1.x.x

Issue type:

• Bug
• Proposal/Enhancement
• Question

---

Tested on:

Desktop

• Chrome
• Chrome Canary
• Chrome dev-channel
• Firefox
• Opera
• Microsoft IE
• Microsoft Edge

Android

• Chrome
• Firefox
• Opera

IOS

• Chrome
• Firefox
• Opera

[sasha240100]

@hirako2000 how to implement?

[hirako2000]

Creating typings, definitelytyped

[ElectrcNINJA-zz]

I can help with this; It would be very nice to have with any project I would use WHS in.

[sasha240100]

@ElectrcNINJA would be awesome cause I am 0 at typescript. Make a fork/branch with a name "#189", work there and do a PR

[thejmazz]

typescript over flow is a good call I think

[thejmazz]

How well does TS handle static properties on a class?

Can it autosuggest a class's static properties in IDEs?

Could maybe annotate components with how they expose bridges with something like

static bridgeTypes = [ ' geometry', 'material', 'mesh', 'onWrap' ]

[hirako2000]

from my little experience with TS, types are perfectly supported, so long as the typings are well defined (and installed) for dep libraries written in JS of course.
IDEs commonly have support for TS autocompletion etc. - excellent support on Atom and VisualCode.

Best is to see int action and appreciate how good it can be to have types available, especially when learning how to use unfamiliar APIs.

If you setup a skeleton typescript project, import a poplar library such as lodash. insteall definitlytyped and lodash's typings.

[zored]

@sasha240100 Waiting for typings. 😄 Have you seen that you can use "types": "./typings/wts.d.ts" in package.json to avoid @types/... dependency?

[hirako2000]

Zored, we do need typings, we've been busy doing other things in the mean time, and would love someone having typings definitions experience or knowledge to take the lead on this.
The typescript boilerplate is set up with typings for other frameworks, including three.js, it would be a nice place to experiment with some basic WHS definitions.

Are you able to give us a hand with this?

[zored]

@hirako2000 ok, I'll write definitions and I'll create pull-request in several days. Currently I try to adapt dts-gen to automate typings generation. Otherwise I'll create them manually. There will be ./typings/*.d.ts in project root similar to @types/three but in project root and without tests for now that are just checking input/output types.

[hirako2000]

I'v started adding type definitions, starting with Core.
Would it make sense to fork DefinitelyTyped under WhitestormJS and contribute there?
We can then make pull requests, it will publish to npm once they get merged by the dt team.

[d-ph]

@hirako2000 Please don't contribute to DT. Instead add the types directly to this project's repo (as @zored said). This is the recommended way of providing typings for js projects.

See vuejs for reference:

1. types/index.d.ts: link
2. In package.json mention the types/index.d.ts in the typings field: link

This way:

1. Devs of whitestorm.js don't need to wait for DT to merge and publish typings changes.
2. Typescript users of whitestorm.js will get the typings automagically after they npm install whs
3. Typings are easier to be kept in sync with the project's codebase.

TS declaration files docs

[hirako2000]

thanks a lot for the input @d-ph, will do that

[hirako2000]

A few types are added and this Issue became a snowball as it included jsDoc setup etc.
Types continued with issue #267
We will have multiple issues to get all types provided by whs