`Size.setSizeToFrame` should mention default behaviour w/o frame; make parameter type optional

[Bertie690]

Version

• Phaser Version: 4.2.1
• Operating system: N/A
• Browser: N/A

Description

The setSizeToFrame method from the Size mixin claims to accept a boolean for the frame parameter, while leaving no mention as to what passing a boolean would even do.

Moreover, attempting to pass true (a valid boolean) to the function will set the object's width/height to undefined and likely cause a crash the next time said fields are used.

To fix this, I propose 2 solutions (all of which can likely be done in tandem):

1. The function should document the fact that it defaults to the current frame if the frame parameter is omitted.
2. The function's typing should be altered to change boolean to undefined and/or make the parameter entirely optional.

Example Test Code

sprite.setSizeToFrame(false); // non obvious, uses current frame
sprite.setSizeToFrame(true); // non obvious and crashes next time sprite is used
sprite.setSizeToFrame(); // would be most ergonomic and works at runtime, but gives type errors

Additional Information

N/A

[photonstorm]

Just do a PR? It's a simple JSDoc fix. The parameter is already optional though in the docs, as it should be. So all that really needs doing is the removal of |boolean. Oh, and the method description is also partly wrong - the part about not changing the hit area is incorrect.

[Bertie690]

The parameter is already optional though in the docs, as it should be.

In that case, this might be yet another parsing defect in jsdoc -- last I checked, the typings file still listed the parameter as required.

[photonstorm]

Nope, it's optional in the defs too:

            setSizeToFrame(frame?: Phaser.Textures.Frame | boolean): this;