Repository navigation
Allow interface event maps in TypeScript - #223
Open
feritcemkahraman wants to merge 1 commit into
Open
feritcemkahraman wants to merge 1 commit into
feritcemkahraman wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request?
What changes did you make?
An event map declared as an interface fails the
Record<EventType, unknown>constraint because it lacks an index signature. Use a mapped constraint so named interface properties work while keeping string/symbol keys and event payload types checked. Fixes #209.Is there anything you'd like reviewers to focus on?
The constraint also rejects numeric keys. The TypeScript regression reproduced TS2344 against the original source; the built declarations accept the interface and reject invalid payloads and unknown event names.
Validation: bundle, typecheck, type tests and lint passed. Mocha: 19 passed on Node 14, matching CI. The all-in-one
npm testfailed on local Node 22 in the legacyesmloader, before running Mocha; lint printed an existing React configuration warning.AI assistance: Codex assisted with the implementation and tests.
Does this PR introduce a breaking change?
The event map constraint is relaxed for interfaces; existing string and symbol key and payload checks remain covered by the type tests.