Skip to content

feat(dts-generator): add TypedJSONModel - trying, wip, do not submit #509

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

akudev
Copy link
Contributor

@akudev akudev commented Jun 20, 2025

Add the type definitions for the TypedJSONModel and adapt the generator to insert them to the core d.ts file.

akudev added 2 commits June 20, 2025 11:39
Add the type definitions for the TypedJSONModel and adapt the generator
to insert them to the core d.ts file.
@akudev akudev force-pushed the feat/typedJSONModelTest branch from 78e3ce3 to 72bc7ce Compare June 23, 2025 11:29
Copy link
Member

@codeworrior codeworrior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this approach totally lacking an entry in the API Reference in the SDK?

@akudev
Copy link
Contributor Author

akudev commented Jun 23, 2025

@codeworrior Yes, and intentionally so, as the API makes no sense for JS developers and would only confuse.
The discoverability for TS developers is of course limited, but isn't that the case for other TS-specific tweaks already, like in the area of ControllerExtensions?
I'd argue that the place for discovering features is either the fulltext documentation (where this should be added) or samples (dito) or the in-editor API suggestions. Not many read the API doc to find out which feature they might want to use.
But we can of course easily add JSDoc saying "only makes a difference in TS".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants