Skip to content

Change enhance function return type to void | Promise<void>#15710

Merged
elliott-with-the-longest-name-on-github merged 1 commit into
sveltejs:mainfrom
Stadly:fix/form-enhance-promise-return
Apr 20, 2026
Merged

Change enhance function return type to void | Promise<void>#15710
elliott-with-the-longest-name-on-github merged 1 commit into
sveltejs:mainfrom
Stadly:fix/form-enhance-promise-return

Conversation

@Stadly

@Stadly Stadly commented Apr 11, 2026

Copy link
Copy Markdown
Contributor

closes #15700

The enhance function can be (and usually is) async. The return type must therefore not be void but void | Promise<void> to prevent triggering @typescript-eslint/no-misused-promises

The return type was changed from void | Promise<void> to void in #15530, which I think was a regression. This PR changes it back.


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:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

@changeset-bot

changeset-bot Bot commented Apr 11, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: b85827d

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 Patch

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

@svelte-docs-bot

Copy link
Copy Markdown

@Stadly Stadly force-pushed the fix/form-enhance-promise-return branch 2 times, most recently from b6040d2 to fbbfe10 Compare April 11, 2026 19:20
@elliott-with-the-longest-name-on-github

Copy link
Copy Markdown
Contributor

@Rich-Harris did you do this intentionally?

Also we should probably use MabyePromise<void> instead of void | Promise<void>

@Stadly Stadly force-pushed the fix/form-enhance-promise-return branch from fbbfe10 to 5700ab4 Compare April 15, 2026 21:23
@Stadly

Stadly commented Apr 15, 2026

Copy link
Copy Markdown
Contributor Author

Updated to using MaybePromise<void>

@Stadly Stadly force-pushed the fix/form-enhance-promise-return branch from 5700ab4 to 7a786f7 Compare April 15, 2026 21:25
@elliott-with-the-longest-name-on-github elliott-with-the-longest-name-on-github merged commit f06726c into sveltejs:main Apr 20, 2026
26 checks passed
@github-actions github-actions Bot mentioned this pull request Apr 20, 2026
@Stadly Stadly deleted the fix/form-enhance-promise-return branch April 20, 2026 23:11
elliott-with-the-longest-name-on-github pushed a commit that referenced this pull request Apr 23, 2026
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @sveltejs/kit@2.58.0

### Minor Changes

- breaking: require `limit` in `requested` (as originally intended)
([#15739](#15739))


- feat: `RemoteQueryFunction` gains an optional third generic parameter
`Validated` (defaulting to `Input`) that represents the argument type
after schema validation/transformation
([#15739](#15739))


- breaking: `requested` now yields `{ arg, query }` entries instead of
the validated argument
([#15739](#15739))

### Patch Changes

- fix: allow `query().current`, `.error`, `.loading`, and `.ready` to
work in non-reactive contexts
([#15699](#15699))


- fix: prevent `deep_set` crash on nullish nested values
([#15600](#15600))


- fix: restore correct `RemoteFormFields` typing for nullable array
fields (e.g. when a schema uses `.default([])`), so `.as('checkbox')`
and friends work again
([#15723](#15723))


- fix: don't warn about removed SSI comments in `transformPageChunk`
([#15695](#15695))

Server-side include (SSI) directives like `<!--#include virtual="..."
-->` are HTML comments that are replaced by servers such as nginx.
Previously, removing them in `transformPageChunk` would trigger a false
positive warning about breaking Svelte's hydration. Since SSI comments
always start with `<!--#` and Svelte's hydration comments never do, they
can be safely excluded from the check.

- Change enhance function return type from void to MaybePromise<void>.
([#15710](#15710))


- fix: throw an error when `resolve` is called with an external URL
([#15733](#15733))


- fix: avoid FOUC for CSR-only pages by loading styles and fonts before
CSR starts ([#15718](#15718))


- fix: reset form result on redirect
([#15724](#15724))

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

Allow Promise<void> as return type of function passed to enhance

2 participants