whs.js icon indicating copy to clipboard operation
whs.js copied to clipboard

Improve types for modules

Open hirako2000 opened this issue 7 years ago • 4 comments

Improve type for those:

  • [x] DefineModule (was missed)
  • [ ] EventsPatchModule
  • [ ] ElementModule (needs to be completed, only constructor is defined)
  • [ ] ControlsModule and OrbitControlsModule (poorly defined typed at the moment)
  • [ ] VirtualMouseModule (Review and add types of the Get methods)
Version:
  • [x] v2.x.x
  • [ ] v1.x.x
Issue type:
  • [ ] Bug
  • [x] Proposal/Enhancement
  • [ ] Question
  • [ ] Discussion

Tested on:
Desktop
  • [ ] Chrome
  • [ ] Chrome Canary
  • [ ] Chrome dev-channel
  • [ ] Firefox
  • [ ] Opera
  • [ ] Microsoft IE
  • [ ] Microsoft Edge
Android
  • [ ] Chrome
  • [ ] Firefox
  • [ ] Opera
IOS
  • [ ] Chrome
  • [ ] Firefox
  • [ ] Opera

hirako2000 avatar Jul 16 '17 17:07 hirako2000

@hirako2000 What's up with this issue? It is set for Milestone 2.1.6, which is the latest release on github, but npm lists 2.1.8, which doesn't contain DefineModule.

btw. great work on getting the typings into whs!

meronbrouwer avatar Sep 28 '17 09:09 meronbrouwer

@hirako2000 In [email protected], there is CameraModule in javascript, but there isn`t CameraModule in typescript. This makes me confused

looading avatar Sep 28 '17 18:09 looading

@looading, CameraModule is now gone, @sasha240100 removed it and came up with the DefineModule which now has types for its interface coming from this issue, but is not yet released on npm, it as just merged to dev branch. (I imagine it will release with v2.1.9)

@meronbrouwer , correct, DefineModule types is not there yet. it shall be released with v2.1.9.

@sasha240100 Do you have a moment to

  • Document our release cadence in readme, then we try to adhere to it as much as possible. see e.g below the quote so that the community sees a bit more clarity.
  • Add a Release tag and push notes for v2.1.8, it's deployed on npm as Travis now automatically publishes releases, but does not automatically create Github release description.

Example of release cadence information:

whs is currently at v2 major version. We don't have clear plans for v3 yet. So v2 will probably remain the main stable version until at least 2018.

We try to publish patch releases every 30days or even more often. We try to publish minor update releases every 90days or even more often depending on the amount of features that sometimes get added in a very small period of time. We want the community to profit from new modules, components and feature enhancements as soon as they are implemented.

hirako2000 avatar Sep 29 '17 18:09 hirako2000

@hirako2000 @looading @meronbrouwer https://github.com/WhitestormJS/whs.js/commit/c192c88abb4a442b7c06276010e5b0198be057d7

sasha240100 avatar Sep 30 '17 19:09 sasha240100