Add loadMusicMetadata() typing for CommonJS (hack)

Borewit · Aug 30, 2024 · 6cfd1c7 · 6cfd1c7
1 parent c9802c4
commit 6cfd1c7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -783,7 +783,7 @@ const { loadMusicMetadata } = require('music-metadata');
 ```
 
 > [!NOTE]
-> The `loadMusicMetadata` function is experimental and is not currently covered by any TypeScript typings.
+> The `loadMusicMetadata` function is experimental.
 
 ## Frequently Asked Questions
 

diff --git a/lib/core.ts b/lib/core.ts
@@ -122,3 +122,5 @@ export async function scanAppendingHeaders(randomReader: IRandomReader, options:
 
   options.apeHeader = await APEv2Parser.findApeFooterOffset(randomReader, apeOffset);
 }
+
+export declare function loadMusicMetadata(): Promise<typeof import('music-metadata')>;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -122,3 +122,5 @@ export async function scanAppendingHeaders(randomReader: IRandomReader, options:

		options.apeHeader = await APEv2Parser.findApeFooterOffset(randomReader, apeOffset);
		}

		export declare function loadMusicMetadata(): Promise<typeof import('music-metadata')>;