Constrain Structs.Map key types - #7377
Open
bagel786 wants to merge 1 commit into
Open
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.
Description
Tightens the typing of
Phaser.Structs.Map(items 1-2 of #7323):Kgeneric tostring | number, so indexing the Map with an object or other unsafe-coercion keys is now a type error.K/Vgenerics fromsetAll(they disabled type safety entirely);elementsis now typed as the nested-array pair form(K|V)[][], which is the closest jsdoc can get to the ideal[K, V][]tuple type until declarations support tuples.elementsparameter is now actually optional in the types, matching its documented and runtime behavior.getnow includesundefinedin its return type, matching its JSDoc.Generated declarations were inspected (the Map class declaration now reads
class Map<K extends string|number, V>,constructor(elements?: (K|V)[][],setAll(elements?: (K|V)[][]): this,get(key: K): V|undefined) but are not included in this PR because the current generator rewrites tens of thousands of unrelated lines.Fixes #7323 (items 1 and 2)
Type of change
Checklist:
pre-commitchecks withpre-commit run --all-files(seeCONTRIBUTING.mdinstructions to set it up)npm run tsand no errors are present.npm run tshas generated that are related to my code to the best of my knowledge.