Skip to content
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

expose stronger typed SubmitFunction #9201

Merged
merged 10 commits into from
Mar 30, 2023

Conversation

ivanhofer
Copy link
Contributor

partially implements #7161

This PR adds stronger type definitions for SubmitFunction to the types genereted inside $types.d.ts. Unfortunately it is currently not possible to distinguish between Success and Invalid with the current Kit helper types. This could be implemented in a future version.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Sorry, something went wrong.

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

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

Thank you! Regarding "not possible to distinguish between success and failure": Wouldn't that be possible if we introduce a new helper type? There's ActionFailure extends the UniqueInterface which means it's possible to know which is which - AwaitedActions already uses this to unpack them. Two new helper types could be used to filter out the fail/success cases.

@ivanhofer
Copy link
Contributor Author

What I really meant is: there are no helper types present to distinguish between those two.
Technically it is possible :)
I haven't had more time on friday to come up with a solution. I'll try to find some time in the coming days.

Copy link
Contributor Author

@ivanhofer ivanhofer left a comment

Choose a reason for hiding this comment

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

@dummdidumm I have added the distinction between success and failure type

@changeset-bot
Copy link

changeset-bot bot commented Mar 21, 2023

🦋 Changeset detected

Latest commit: 1ad8a3b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Minor

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

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

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

Thank you!

@dummdidumm dummdidumm merged commit 369e7d6 into sveltejs:master Mar 30, 2023
@github-actions github-actions bot mentioned this pull request Mar 30, 2023
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.

None yet

2 participants