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

feat: typed context draft #9522

Closed
wants to merge 1 commit into from

Conversation

olehmisar
Copy link

Svelte lacks strong types in it's context functions. This PR is a draft of what this could look like. More details in this issue: #8941.

  1. I tried to preserve backwards compatibility by replacing key: any with key: {}. It should be the same as before except undefined and null. But I don't think someone used undefined or null as keys anyway.

  2. There are 2 commented out tests because I didn't want to think how to fix those edge cases because IDK if this PR will even be merged.

  3. There is a nasty edge case with getContext(Symbol()), which returns T | undefined instead of T. But I believe if # 2 is resolved, this will be resolved too.

  4. Also, I moved getContext types to public.d.ts because JSDoc doesn't support function overloads(as far as I am aware).

Is it possible for this to be merged in Svelte 5?

Svelte 5 rewrite

Please note that the Svelte codebase is currently being rewritten for Svelte 5. Changes should target Svelte 5, which lives on the default branch (main).

If your PR concerns Svelte 4 (including updates to svelte.dev.docs), please ensure the base branch is svelte-4 and not main.

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
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests and linting

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

Copy link

changeset-bot bot commented Nov 17, 2023

⚠️ No Changeset found

Latest commit: 54b0911

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Nov 17, 2023

@olehmisar is attempting to deploy a commit to the Svelte Team on Vercel.

A member of the Team first needs to authorize it.

@Rich-Harris
Copy link
Member

Thank you for this — per #11042 (comment), we're going to revisit this post-5.0, so for the sake of clearing out the PR queue I'm going to close this for now

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.

2 participants