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

allow to type Params of RequestHandler #3989

Merged
merged 3 commits into from
Feb 21, 2022

Conversation

ivanhofer
Copy link
Contributor

@ivanhofer ivanhofer commented Feb 18, 2022

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 pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

Currently it is not possible to type Params of a RequestHandler handler function

import type { RequestHandler } from '@sveltejs/kit'

type ReturnType = { id: string }

// current
export const get: RequestHandler<ReturnType> = ({ params }) => {
   return {
      body: {
         // `params.id` is of type `string | undefined`
         id: params.id
      },
   }
}

// with the changes of this PR
type ParamsType = { id: string }

export const get: RequestHandler<ParamsType, ReturnType> = ({ params }) => {
   return {
      body: {
         // `params.id` is of type `string`
         id: params.id
      },
   }
}

@changeset-bot
Copy link

changeset-bot bot commented Feb 18, 2022

🦋 Changeset detected

Latest commit: 44ad923

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

@dummdidumm
Copy link
Member

If we add this, I feel like we should make this a breaking change and switch the order of generics. Feels strange to me to have the input generic be the second generic, but maybe that's just me

@ivanhofer
Copy link
Contributor Author

I was also thinking about this, but didn't want to introduce a breaking change. I'll update it

@benmccann
Copy link
Member

this PR would need to be rebased

@ivanhofer
Copy link
Contributor Author

this PR would need to be rebased

done

@Rich-Harris
Copy link
Member

agree that input should go first, though i'll note that if we manage to pull off #647 we'll have to revert this breaking change with another. i don't think that's a reason not to do it though

@Rich-Harris Rich-Harris merged commit 9e2d40d into sveltejs:master Feb 21, 2022
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.

4 participants