Fix jsdoc in setWordWrapWidth from Text and TextStyle #6813
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.
This PR
Describe the changes below:
I was using typescript phaser version when I found an issue with
Phaser.GameObjects.Text.setWordWrapWidth
, the method description says: params width - The maximum width of a line in pixels. Set to null to remove wrapping.So I tried to set it to null.
![image](https://private-user-images.githubusercontent.com/23361386/328452846-c854c4cf-90e3-4595-9123-0d303b1f4441.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTg5MjM2OTAsIm5iZiI6MTcxODkyMzM5MCwicGF0aCI6Ii8yMzM2MTM4Ni8zMjg0NTI4NDYtYzg1NGM0Y2YtOTBlMy00NTk1LTkxMjMtMGQzMDNiMWY0NDQxLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA2MjAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNjIwVDIyNDMxMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTZhZTAzMzRiNDJiNjdlNGJjZTY5M2UxYmUzNWFjNDEyZDZjMWMzZDc0OGNkYzQ0OWI0ODFkYjI2Y2IzZDY1MWMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.rlPorVIs_oM-AkgbDtYt0WO_b6PwzYssz38KEJw0BnY)
But the following typescript error appeared. That's because the method jsdoc don't allow passing null, just undefined.
Reading the source code, I found that null is the correct value to pass here.
This PR changes the jsdoc to allow passing null to the method without errors.
I didn't generate the
.d.ts
definitions withnpm run tsgen
, which is something I think should be done by the maintainers of the project when new releases of the project are generated. Please do it after these changes.I hope it helps, have a nice day!