refactor(types): improve FormatType auto-generated API docs

buzz · May 28, 2024 · a083e96 · a083e96
1 parent 4405da4
commit a083e96
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 13 deletions.
diff --git a/src/MediaInfo.ts b/src/MediaInfo.ts
@@ -1,16 +1,12 @@
 import { unknownToError } from './error.js'
 import { FLOAT_FIELDS, INT_FIELDS, type MediaInfoType, type TrackType } from './MediaInfoType.js'
 import type { MediaInfoFactoryOptions } from './mediaInfoFactory.js'
-import type {
-  MediaInfoModule,
-  MediaInfoWasmInterface,
-  WasmConstructableFormatType,
-} from './MediaInfoModule.js'
+import type { MediaInfoModule, MediaInfoWasmInterface } from './MediaInfoModule.js'
 
 const MAX_UINT32_PLUS_ONE = 2 ** 32
 
 /** Format of the result type */
-type FormatType = 'object' | WasmConstructableFormatType
+type FormatType = 'object' | 'JSON' | 'XML' | 'HTML' | 'text'
 
 type MediaInfoOptions<TFormat extends FormatType> = Required<
   Omit<MediaInfoFactoryOptions<TFormat>, 'locateFile'>

diff --git a/src/MediaInfoModule.d.ts b/src/MediaInfoModule.d.ts
@@ -24,10 +24,5 @@ interface MediaInfoModule extends EmscriptenModule {
 
 declare const mediaInfoModuleFactory: EmscriptenModuleFactory<MediaInfoModule>
 
-export type {
-  MediaInfoModule,
-  MediaInfoWasmConstructable,
-  MediaInfoWasmInterface,
-  WasmConstructableFormatType,
-}
+export type { MediaInfoModule, MediaInfoWasmConstructable, MediaInfoWasmInterface }
 export default mediaInfoModuleFactory
diff --git a/src/mediaInfoFactory.ts b/src/mediaInfoFactory.ts
@@ -59,7 +59,7 @@ function mediaInfoFactory<TFormat extends FormatType = typeof DEFAULT_OPTIONS.fo
 ): Promise<MediaInfo<TFormat>>
 
 /**
- * Factory function for {@link mediaInfoFactory}.
+ * Factory function for {@link MediaInfo}.
  *
  * @param options User options
  * @param callback Function that is called once the module is created