docs: fix example in README #18
Merged
Conversation
This file contains 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
Using an interface to define events triggers a TypeScript error: > Type 'Events' does not satisfy the constraint 'EventMap'. > Index signature for type 'string' is missing in type 'Events'. This is due to a peculiar behavior of TypeScript compiler that only allows use of types in such curcumstances (see microsoft/TypeScript#15300). So I replaced the interface with a type. (A type is actually already used in another example above.) [Test in TS playground](https://www.typescriptlang.org/play/?#code/JYWwDg9gTgLgBAbzgURMGMCmU4F84BmUEIcA5AM4xTADGMAtJgG6YB2jmaG2ZAUHwD0guAEYAdHAAimAsDaY4AQzZx5WKASW1FMABZL4AE0wVaNAEam4ATwgBXHC3YwK4oSIDKmeM45w2JRBrJQo4fUUAa0wbCgAaZTYjcL1MYCcADzBMekxksCUbABsIJSMw0LhmJSL7U3cYG2yUVg4wgF5EPjg4Wgg2BXoALjgAbWAjEaoaNgBzAF1uuCNgM37BmBHxybhp+QW+XAFhOAAmSQBhKExDRSVd6jpfbg1E-NCwiLgwa+ZgBwoRRsy1k8jycAARMhWq4IR5lGF0GE5FAqHBZuxsHRlFBZvZghx3H02GiuOhXp0FAB3FAvbAAHmhLgoAD4ABQASmOIgAzJIAKoUXSpSFknhQCEpRQUIKKKmFWwOMjJexCqVwa54opKHBQmGocnYSXyKgqHTuMUacRlIwAGVWWAUUDZZGJGzICTZEw5cHaLMQuC5luw4jFLrdORgHvISgstAYolOPLIXKAA)
kettanaito
approved these changes
Aug 6, 2024
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.
Using an interface to define events triggers a TypeScript error:
This is due to a peculiar behavior of TypeScript compiler that only allows use of types in such curcumstances (see microsoft/TypeScript#15300).
So I replaced the interface with a type. (A type is actually already used in another example above.)
Playground link