[@types/three] Understanding interface changes

[EdwardMoyse]

This is mostly just for my education. My project has a problem upgrading to three v0.164 basically because we had this in our code:

  private textFont: Font = new Font(HelvetikerFont);

https://github.com/HSF/phoenix/blob/13cdc34bdde7800080d04da342e3d9b483df18ec/packages/phoenix-event-display/src/managers/three-manager/scene-manager.ts#L68

FontData was introduced in #69203, which breaks this.

However if I look at the library documentation for FontLoader
it has a different interface, namely parse(json: Object) instead of parse(json: FontData) in https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three.

I'm just wondering if it is normal to have a more restrictive interface here than in the base library? I was very confused about what was going on, until I looked at FontLoader.d.ts

[typescript-bot]

Thanks for the discussion about "three", some useful links for everyone:

• npm
• DT
• Related discussions

Pinging the DT module owners: @joshuaellis, @Methuselah96.

[Methuselah96]

Hey @EdwardMoyse thanks for raising this issue!

However if I look at the library documentation for FontLoader
it has a different interface, namely parse(json: Object) instead of parse(json: FontData) in https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three.

I'm just wondering if it is normal to have a more restrictive interface here than in the base library? I was very confused about what was going on, until I looked at FontLoader.d.ts

In short, yes. The documentation doesn't always fully spell out the types of Object in cases like this, but the TypeScript types are a bit more fleshed out for better type-safety.

The issue that you're having is actually that some of your glyphs don't have the o property. This is an oversight in the three.js types, and should be fixed by three-types/three-ts-types#934 and released as part of @types/[email protected].

Let me know if you have any other questions!

[EdwardMoyse]

Thanks for the explanation. I'll wait for 0.165 then.