Skip to content

fix: allow optional types for remote query/command/prerender functions#15293

Merged
teemingc merged 2 commits intomainfrom
optional-remote-types
Feb 25, 2026
Merged

fix: allow optional types for remote query/command/prerender functions#15293
teemingc merged 2 commits intomainfrom
optional-remote-types

Conversation

@dummdidumm
Copy link
Member

We're using the arg: undefined extends Input ? Input | void : Input method and not the ...args: undefined extends Input ? [arg?: Input] : [arg: Input] method because the former does work in more cases (the latter throws a type error in our own code around generics), even though the TS team likely wants us to use the latter (but that pattern is in so many code bases now that this behavior around void will never change).

One drawback (of either method) is that without strict mode all commands/queries/prerenders have optional args now, because undefined extends X is always true in non-strict mode. But since noone who uses type checking nowadays should use non-strict mode anyway, it's fine.

fixes #14500


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

We're using the `arg: undefined extends Input ? Input | void : Input` method and not the `...args: undefined extends Input ? [arg?: Input] : [arg: Input]` method because the former does work in more cases (the latter throws a type error in our own code around generics), even though the TS team likely wants us to use the latter (but that pattern is in so many code bases now that this behavior around `void` will never change).

One drawback (of either method) is that without strict mode all commands/queries/prerenders have optional args now, because `undefined extends X` is always `true` in non-strict mode. But since noone who uses type checking nowadays should use non-strict mode anyway, it's fine.

fixes #14500
@changeset-bot
Copy link

changeset-bot bot commented Feb 9, 2026

🦋 Changeset detected

Latest commit: 7218f7b

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

@teemingc teemingc merged commit d28d372 into main Feb 25, 2026
27 checks passed
@teemingc teemingc deleted the optional-remote-types branch February 25, 2026 10:34
This was referenced Feb 25, 2026
Copilot AI pushed a commit to Stadly/kit that referenced this pull request Mar 6, 2026
sveltejs#15293)

We're using the `arg: undefined extends Input ? Input | void : Input`
method and not the `...args: undefined extends Input ? [arg?: Input] :
[arg: Input]` method because the former does work in more cases (the
latter throws a type error in our own code around generics), even though
the TS team likely wants us to use the latter (but that pattern is in so
many code bases now that this behavior around `void` will never change).

One drawback (of either method) is that without strict mode all
commands/queries/prerenders have optional args now, because `undefined
extends X` is always `true` in non-strict mode. But since noone who uses
type checking nowadays should use non-strict mode anyway, it's fine.

fixes sveltejs#14500

---

### Please don't delete this checklist! Before submitting the PR, please
make sure you do the following:
- [x] 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
- [x] This message body should clearly illustrate what problems it
solves.
- [x] Ideally, include a test that fails without this PR but passes with
it.

### Tests
- [x] Run the tests with `pnpm test` and lint the project with `pnpm
lint` and `pnpm check`

### Changesets
- [x] 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:`.

Co-authored-by: Tee Ming <chewteeming01@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow remote function argument to be optional

2 participants