`Map.getGlyphs()`, `setGlyphs()` should allow unset glyphs

[1ec5]

The type of Map.getGlyphs() should indicate that it may return null in some situations. setGlyphs() should accept something falsy in order to unset glyphs.

Currently, if the stylesheet initially has glyphs unset, getGlyphs() correctly returns null, but the TypeScript signature for this method says it can only return a nonnull string. setGlyphs() requires the first parameter to be a string containing {fontstack} and {range} tokens. The style specification has always allowed glyphs to be unset if the style lacks any symbol layer that specifies text-field. As of maplibre/maplibre-style-spec#1068, glyphs can also be unset otherwise.

[HarelM]

Feel free to submit a PR, this should be an easy fix.

[1ec5]

Huh, the actual methods do accept null and it says so in the source, but it doesn’t show up in the rendered documentation. Any idea why that might be?

maplibre-gl-js/src/ui/map.ts

Line 2917 in b457ca9

getGlyphs(): string | null {

maplibre-gl-js/src/ui/map.ts

Line 2906 in b457ca9

setGlyphs(glyphsUrl: string | null, options: StyleSetterOptions = {}): this {

maplibre-gl-js/src/style/style.ts

Line 1922 in 7b5bac9

if (glyphsUrl && this._validate(validateStyle.glyphs, 'glyphs', glyphsUrl, null, options)) {

[HarelM]

Weird, try adding undefined and see if it changes anything, you can generate the docs locally and see.

[HarelM]

According to this issue it won't work:

• Optional return types for method is not shown TypeStrong/typedoc#2865

I'm not sure there's anything to do as adding strict null check would result in enormous amount of errors...

[shreeharshshinde]

@HarelM I request to have a look on my PR