-
Notifications
You must be signed in to change notification settings - Fork 3.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Two small JSDoc/TS fixes #8928
Two small JSDoc/TS fixes #8928
Conversation
1. `EllipsoidTangentPlane.fromPoints` takes an array. 2. `EntityCollection.getById` and `CompositeEntityCollection.getById` can both return undefined.
Thanks for the pull request @mramato!
Reviewers, don't forget to make sure that:
|
The doc fixes look right to me. Do you have a minimal TypeScript config you can share with me to help me test these? Like a |
Also fix missing links from previous PRs
- Improved `MaterialProperty` JSDoc and TypeScript type definitions, which were missing the ability to take primitive types in addition to Property instances in their constructor. | ||
- Fixed `EllipsoidGeodesic` JSDoc and TypeScript type definitions which incorrectly listed `result` as required. | ||
- Improved `MaterialProperty` JSDoc and TypeScript type definitions, which were missing the ability to take primitive types in addition to Property instances in their constructor. [#8904](https://github.com/CesiumGS/cesium/pull/8904) | ||
- Fixed `EllipsoidGeodesic` JSDoc and TypeScript type definitions which incorrectly listed `result` as required. [#8904](https://github.com/CesiumGS/cesium/pull/8904) | ||
- Fixed a bug with handling of PixelFormat's flipY. [#8893](https://github.com/CesiumGS/cesium/pull/8893) | ||
- Fixed JSDoc and TypeScript type definitions for all `ImageryProvider` types, which were missing `defaultNightAlpha` and `defaultDayAlpha` properties. | ||
- Fixed JSDoc and TypeScript type definitions for all `ImageryProvider` types, which were missing `defaultNightAlpha` and `defaultDayAlpha` properties. [#8908](https://github.com/CesiumGS/cesium/pull/8908) | ||
- Fixed JSDoc and TypeScript type definitions for `EllipsoidTangentPlane.fromPoints`, which takes an array of `Cartesian3`, not a single instance. [#8928](https://github.com/CesiumGS/cesium/pull/8928) | ||
- Fixed JSDoc and TypeScript type definitions for `EntityCollection.getById` and `CompositeEntityCollection.getById`, which can both return undefined. [#8928](https://github.com/CesiumGS/cesium/pull/8928) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These should all be moved under a new "1.70.1" patch release right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, everything currently in 1.71.0 will be part of 1.70.1, so everything can just stay here until we update the 1.71.0 header to take the release.
@OmarShehata You have 3 options for TS PRs:
For most TS-related fixes, 1 is going to be good enough but totally understand that you would want to get comfortable playing with these things so let me know if you have any problems/questions with 3. (and in reality 3 is the most thorough). |
I can see the generated types in
|
I was able to fix this issue with Matt's suggestion over Slack by running I was able to test the changed classes in |
EllipsoidTangentPlane.fromPoints
takes an array.EntityCollection.getById
andCompositeEntityCollection.getById
canboth return undefined.
Fixes #8926
Handles bullet 1 from #8927