fix: typedef localIdeographFontFamily #3895 (#3896)

* fix: typedef localIdeographFontFamily #3895 * fix: not optional * fix: not optional * fix: revert to optional * fix: not optional * fix: not optional * add changelog #3896
maplibre · Mar 25, 2024 · c0aee04 · c0aee04
1 parent f6035db
commit c0aee04
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,7 @@
 - _...Add new stuff here..._
 
 ### 🐞 Bug fixes
-- _...Add new stuff here..._
+- fix type defnition on `localIdeographFontFamily` ([#3896](https://github.com/maplibre/maplibre-gl-js/pull/3896))
 
 ## 4.1.1
 

diff --git a/src/render/glyph_manager.ts b/src/render/glyph_manager.ts
@@ -24,15 +24,15 @@ type Entry = {
 
 export class GlyphManager {
     requestManager: RequestManager;
-    localIdeographFontFamily: string;
+    localIdeographFontFamily: string | false;
     entries: {[stack: string]: Entry};
     url: string;
 
     // exposed as statics to enable stubbing in unit tests
     static loadGlyphRange = loadGlyphRange;
     static TinySDF = TinySDF;
 
-    constructor(requestManager: RequestManager, localIdeographFontFamily?: string | null) {
+    constructor(requestManager: RequestManager, localIdeographFontFamily?: string | false) {
         this.requestManager = requestManager;
         this.localIdeographFontFamily = localIdeographFontFamily;
         this.entries = {};

diff --git a/src/style/style.ts b/src/style/style.ts
@@ -88,7 +88,7 @@ export type StyleOptions = {
      * Set to `false`, to enable font settings from the map's style for these glyph ranges.
      * Forces a full update.
      */
-    localIdeographFontFamily?: string;
+    localIdeographFontFamily?: string | false;
 };
 
 /**

diff --git a/src/ui/map.ts b/src/ui/map.ts
@@ -292,7 +292,7 @@ export type MapOptions = {
      * The purpose of this option is to avoid bandwidth-intensive glyph server requests. (See [Use locally generated ideographs](https://maplibre.org/maplibre-gl-js/docs/examples/local-ideographs).)
      * @defaultValue 'sans-serif'
      */
-    localIdeographFontFamily?: string;
+    localIdeographFontFamily?: string | false;
     /**
      * The map's MapLibre style. This must be a JSON object conforming to
      * the schema described in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/),
@@ -464,7 +464,7 @@ export class Map extends Camera {
     _renderTaskQueue: TaskQueue;
     _controls: Array<IControl>;
     _mapId: number;
-    _localIdeographFontFamily: string;
+    _localIdeographFontFamily: string | false;
     _validateStyle: boolean;
     _requestManager: RequestManager;
     _locale: typeof defaultLocale;