Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(types): support custom VitePreloadErrorEvent #17615

Merged
merged 6 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions packages/vite/client.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -246,3 +246,20 @@ declare module '*?inline' {
const src: string
export default src
}

declare interface VitePreloadErrorEvent extends Event {
payload: Error
}

declare interface Window {
addEventListener(
type: 'vite:preloadError',
listener: (this: Window, ev: VitePreloadErrorEvent) => unknown,
options?: boolean | AddEventListenerOptions,
): void
removeEventListener(
type: 'vite:preloadError',
listener: (this: Window, ev: VitePreloadErrorEvent) => unknown,
options?: boolean | EventListenerOptions,
): void
}
7 changes: 5 additions & 2 deletions packages/vite/src/node/plugins/importAnalysisBuild.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ type FileDep = {
runtime: boolean
}

type VitePreloadErrorEvent = Event & { payload: Error }

/**
* A flag for injected helpers. This flag will be set to `false` if the output
* target is not native es - so that injected helper logic can be conditionally
Expand Down Expand Up @@ -145,8 +147,9 @@ function preload(
return promise
.then(() => baseModule())
.catch((err) => {
const e = new Event('vite:preloadError', { cancelable: true })
// @ts-expect-error custom payload
const e = new Event('vite:preloadError', {
cancelable: true,
}) as VitePreloadErrorEvent
e.payload = err
window.dispatchEvent(e)
if (!e.defaultPrevented) {
Expand Down