Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
update api-hmr docs
  • Loading branch information
94726 committed Mar 5, 2025
commit c364e37477f154ed83c001f1f2e4ec24cefc8ffe
14 changes: 10 additions & 4 deletions docs/guide/api-hmr.md
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
5 changes: 4 additions & 1 deletion packages/vite/types/customEvent.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +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 & {})