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: provide ContextKey type for better typing of setContext/getContext #11042

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dummdidumm
Copy link
Member

Wanted to see if this requires a breaking change, which would be an RC blocker, and the only way to find out was to implement it. Draft mode because we need to agree on the detailed API of this PR.

Not completly ideal because you can circumvent the type safety by doing getContext<SomeType>(context_key) - changing this would require a breaking change, which we could do in Svelte 6 after we've given ContextKey some time to establish itself. Also doesn't add the interesting type narrowing idea in https://github.com/KamenKolev/svelte-typed-context/blob/master/index.ts#L14 (yet), probably easier to do together with said breaking change.

closes #8941

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

…text`

Not completly ideal because you can circumvent the type safety by doing `getContext<SomeType>(context_key)` - changing this would require a breaking change, which we could do in Svelte 6 after we've given `ContextKey` some time to establish itself.
Also doesn't add the interesting type narrowing idea in https://github.com/KamenKolev/svelte-typed-context/blob/master/index.ts#L14 (yet), probably easier to do together with said breaking change.

closes #8941
Copy link

changeset-bot bot commented Apr 3, 2024

🦋 Changeset detected

Latest commit: f076646

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

This PR includes changesets to release 1 package
Name Type
svelte 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

@olehmisar
Copy link

Hey. Did you see my attempt #9522? It has a check for hasContext, so this code will be properly typechecked:

const a = getContext(key); // T | undefined
if (hasContext(key)) {
  const b = getContext(key); // T
}

Not sure if this is worth the complexity added, though.

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.

Use ContextKey<T> to type setContext, getContext and hasContext
2 participants