fix(woff-format-options): add correct option with documentation

tancredi · Dec 22, 2020 · f495d5d · f495d5d
1 parent b2665f9
commit f495d5d
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 6 deletions.
diff --git a/src/generators/asset-types/woff.ts b/src/generators/asset-types/woff.ts
@@ -6,10 +6,7 @@ const generator: FontGenerator<Buffer> = {
   dependsOn: FontAssetType.TTF,
 
   async generate({ formatOptions }, ttf) {
-    const font = ttf2woff(
-      new Uint8Array(ttf),
-      formatOptions[FontAssetType.WOFF]
-    );
+    const font = ttf2woff(new Uint8Array(ttf), formatOptions?.woff);
     return Buffer.from(font.buffer);
   }
 };

diff --git a/src/types/modules/ttf2woff.d.ts b/src/types/modules/ttf2woff.d.ts
@@ -1,4 +1,14 @@
 declare module 'ttf2woff' {
-  function ttf2woff(ttf: Uint8Array, options: any): Buffer;
+  function ttf2woff(
+    ttf: Uint8Array,
+    options?: {
+      /**
+       * Woff Extended Metadata Block
+       *
+       * See https://www.w3.org/TR/WOFF/#Metadata
+       */
+      metadata?: string;
+    }
+  ): Buffer;
   export default ttf2woff;
 }
diff --git a/src/types/runner.ts b/src/types/runner.ts
@@ -10,7 +10,14 @@ export interface RunnerMandatoryOptions {
 export interface FormatOptions {
   eot?: any;
   woff2?: any;
-  woff?: any;
+  woff?: {
+    /**
+     * Woff Extended Metadata Block
+     *
+     * See https://www.w3.org/TR/WOFF/#Metadata
+     */
+    metadata?: string;
+  };
   ttf?: any;
   svg?: Pick<
     SvgIcons2FontOptions,