CesiumGS / CesiumGS/cesium

ScreenSpaceEventHandler has incomplete JSDoc/TypeScript definitions

Open
#8,945 1 comment 0 reactions 0 assignees View on GitHub
category - typescript type - bug
Dominant language
JavaScript
Stars
15.7k
Forks
3.9k
Avg merge
4d 6h
Merged PRs (30d)
34

Description

As reported in #8927, `ScreenSpaceEventHandler` actions have no documentation or TypeScript definitions regarding the signature of the callback function that is called. I think we just need to go through all of the xxxEvent properties locally defined in `ScreenSpaceEventHandler` and properly document/expose them (which will then get picked up by TypeScript).

As part of this, it would probably be good to look at the TS `ScreenSpaceEventHandler` type definition we generate and make sure there are no other similar issues and that what we define is as specific as possible.

Contributor guide

Open the contributing guide

Research direction

Start with the locally defined xxxEvent properties on ScreenSpaceEventHandler and inspect the generated TypeScript ScreenSpaceEventHandler type definition. Compare each callback signature with the available behavior, then verify that the generated definitions expose specific signatures for all relevant events.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.