fix(svelte): remove optional markers from defineWidget component props#1004
Closed
abhi-0203 wants to merge 2 commits into
Closed
fix(svelte): remove optional markers from defineWidget component props#1004abhi-0203 wants to merge 2 commits into
abhi-0203 wants to merge 2 commits into
Conversation
The `defineWidget` function always passes `model` and `bindings` to the Svelte component, so the JSDoc type should not mark them as optional (`?`). This was causing TypeScript to require explicit handling of `undefined` values or explicit type casts in user code. Closes #1000
🦋 Changeset detectedLatest commit: 159a686 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Removes the optional markers (
?) from themodelandbindingsprops in the JSDoc type annotation fordefineWidget.Problem
The
defineWidgetfunction in@anywidget/svelteexpects a Svelte component typed as:This makes
modelandbindingsoptional (can beundefined), but in reality they are always passed to the component in therendermethod. This causes TypeScript to require either explicit handling ofundefinedvalues or explicit type casts in user code.Solution
Change the type to:
This correctly reflects that both props are always provided, eliminating the need for unnecessary
undefinedchecks in user components.Closes #1000