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.

Sign up for GitHub

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): type hints for hmr events #19579

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(types): type hints for hmr events #19579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7c9529
feat: type hints for hmr events
94726 Mar 5, 2025
c364e37
update api-hmr docs
94726 Mar 5, 2025
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
14 changes: 10 additions & 4 deletions docs/guide/api-hmr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ Vite exposes its manual HMR API via the special `import.meta.hot` object:

```ts twoslash
import type { ModuleNamespace } from 'vite/types/hot.d.ts'
import type { InferCustomEventPayload } from 'vite/types/customEvent.d.ts'
import type {
CustomEventName,
InferCustomEventPayload,
} from 'vite/types/customEvent.d.ts'

// ---cut---
interface ImportMeta {
Expand All @@ -32,15 +35,18 @@ interface ViteHotContext {
prune(cb: (data: any) => void): void
invalidate(message?: string): void

on<T extends string>(
on<T extends CustomEventName>(
event: T,
cb: (payload: InferCustomEventPayload<T>) => void,
): void
off<T extends string>(
off<T extends CustomEventName>(
event: T,
cb: (payload: InferCustomEventPayload<T>) => void,
): void
send<T extends string>(event: T, data?: InferCustomEventPayload<T>): void
send<T extends CustomEventName>(
event: T,
data?: InferCustomEventPayload<T>,
): void
}
```

Expand Down
7 changes: 6 additions & 1 deletion packages/vite/types/customEvent.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,12 @@ export interface InvalidatePayload {
}

/**
* provides types for built-in Vite events
* provides types for payloads of built-in Vite events
*/
export type InferCustomEventPayload<T extends string> =
T extends keyof CustomEventMap ? CustomEventMap[T] : any

/**
* provides types for names of built-in Vite events
*/
export type CustomEventName = keyof CustomEventMap | (string & {})
11 changes: 7 additions & 4 deletions packages/vite/types/hot.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { InferCustomEventPayload } from './customEvent'
import type { CustomEventName, InferCustomEventPayload } from './customEvent'

export type ModuleNamespace = Record<string, any> & {
[Symbol.toStringTag]: 'Module'
Expand All @@ -24,13 +24,16 @@ export interface ViteHotContext {
prune(cb: (data: any) => void): void
invalidate(message?: string): void

on<T extends string>(
on<T extends CustomEventName>(
event: T,
cb: (payload: InferCustomEventPayload<T>) => void,
): void
off<T extends string>(
off<T extends CustomEventName>(
event: T,
cb: (payload: InferCustomEventPayload<T>) => void,
): void
send<T extends string>(event: T, data?: InferCustomEventPayload<T>): void
send<T extends CustomEventName>(
event: T,
data?: InferCustomEventPayload<T>,
): void
}