Workaround for TypeScript bundler node-resolution #2378
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add stub to fool TypeScript compiler, loading the wrong entry points for the typings. For calling the runtime problems, it throws an error.
2 tasks
net
reviewed
Mar 10, 2025
Comment on lines
+128
to
+134
| /** | ||
| * Implementation only available when loaded as Node.js | ||
| * This method will throw an Error, always. | ||
| */ | ||
| export async function parseFile(filePath: string, options: IOptions = {}): Promise<IAudioMetadata> { | ||
| throw new Error('To load Web API File objects use parseBlob instead. For loading files, you need to import with the "node" condition is set.'); | ||
| } |
There was a problem hiding this comment.
Maybe something like
Suggested change
| /** | |
| * Implementation only available when loaded as Node.js | |
| * This method will throw an Error, always. | |
| */ | |
| export async function parseFile(filePath: string, options: IOptions = {}): Promise<IAudioMetadata> { | |
| throw new Error('To load Web API File objects use parseBlob instead. For loading files, you need to import with the "node" condition is set.'); | |
| } | |
| /** | |
| * Parse audio from Node file | |
| * | |
| * Only available when running in a Node.js environment. | |
| * | |
| * @param filePath - Media file to read meta-data from | |
| * @param options - Parsing options | |
| * @returns Metadata | |
| */ | |
| export async function parseFile(filePath: string, options: IOptions = {}): Promise<IAudioMetadata> { | |
| throw new Error(`music-metadata's parseFile is not available in this runtime. | |
| If you are running in a browser, use parseBlob instead. | |
| If you are running in a Node.js environment, you may need to set | |
| "customConditions": ["node"] | |
| in your tsconfig.json. | |
| (See https://github.com/Borewit/music-metadata/issues/2370.)`); | |
| } |
There was a problem hiding this comment.
The "customConditions": ["node"] is TypeScript specific, and with TypeScript the user will not get this error.
|
Part of v11.0.2 |
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add stub to fool TypeScript compiler, loading the wrong entry points for the typings.
For calling the runtime problems, it throws an error.
Change suggested by @net: #2370 (comment)