Unverified Commit 755a1b41 authored by Brandon Bayer's avatar Brandon Bayer Committed by GitHub

Strongly type `Router.events.on` and `Router.events.off` (#26456)

This strongly types `Router.events.on` and `Router.events.off`. Previously the event type was `string` but now it's `'routeChangeStart' | 'beforeHistoryChange' | 'routeChangeComplete' | 'routeChangeError' | 'hashChangeStart' | 'hashChangeComplete'`


## Bug

- ~[ ] Related issues linked using `fixes #number`~
- [x] Integration tests added

Closes #25679
Closes #23753
Closes #15497
parent 9fefd3cc
...@@ -259,7 +259,7 @@ class Container extends React.Component<{ ...@@ -259,7 +259,7 @@ class Container extends React.Component<{
} }
} }
export const emitter: MittEmitter = mitt() export const emitter: MittEmitter<string> = mitt()
let CachedComponent: React.ComponentType let CachedComponent: React.ComponentType
export default async (opts: { webpackHMR?: any } = {}) => { export default async (opts: { webpackHMR?: any } = {}) => {
......
...@@ -52,7 +52,9 @@ const routerEvents = [ ...@@ -52,7 +52,9 @@ const routerEvents = [
'routeChangeError', 'routeChangeError',
'hashChangeStart', 'hashChangeStart',
'hashChangeComplete', 'hashChangeComplete',
] ] as const
export type RouterEvent = typeof routerEvents[number]
const coreMethodFields = [ const coreMethodFields = [
'push', 'push',
'replace', 'replace',
...@@ -90,7 +92,7 @@ coreMethodFields.forEach((field: string) => { ...@@ -90,7 +92,7 @@ coreMethodFields.forEach((field: string) => {
} }
}) })
routerEvents.forEach((event: string) => { routerEvents.forEach((event) => {
singletonRouter.ready(() => { singletonRouter.ready(() => {
Router.events.on(event, (...args) => { Router.events.on(event, (...args) => {
const eventField = `on${event.charAt(0).toUpperCase()}${event.substring( const eventField = `on${event.charAt(0).toUpperCase()}${event.substring(
......
...@@ -16,13 +16,13 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI ...@@ -16,13 +16,13 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
type Handler = (...evts: any[]) => void type Handler = (...evts: any[]) => void
export type MittEmitter = { export type MittEmitter<T> = {
on(type: string, handler: Handler): void on(type: T, handler: Handler): void
off(type: string, handler: Handler): void off(type: T, handler: Handler): void
emit(type: string, ...evts: any[]): void emit(type: T, ...evts: any[]): void
} }
export default function mitt(): MittEmitter { export default function mitt(): MittEmitter<string> {
const all: { [s: string]: Handler[] } = Object.create(null) const all: { [s: string]: Handler[] } = Object.create(null)
return { return {
......
...@@ -12,6 +12,7 @@ import { ...@@ -12,6 +12,7 @@ import {
isAssetError, isAssetError,
markAssetError, markAssetError,
} from '../../../client/route-loader' } from '../../../client/route-loader'
import { RouterEvent } from '../../../client/router'
import { DomainLocales } from '../../server/config' import { DomainLocales } from '../../server/config'
import { denormalizePagePath } from '../../server/denormalize-page-path' import { denormalizePagePath } from '../../server/denormalize-page-path'
import { normalizeLocalePath } from '../i18n/normalize-locale-path' import { normalizeLocalePath } from '../i18n/normalize-locale-path'
...@@ -522,7 +523,7 @@ export default class Router implements BaseRouter { ...@@ -522,7 +523,7 @@ export default class Router implements BaseRouter {
clc: ComponentLoadCancel clc: ComponentLoadCancel
pageLoader: any pageLoader: any
_bps: BeforePopStateCallback | undefined _bps: BeforePopStateCallback | undefined
events: MittEmitter events: MittEmitter<RouterEvent>
_wrapApp: (App: AppComponent) => any _wrapApp: (App: AppComponent) => any
isSsr: boolean isSsr: boolean
isFallback: boolean isFallback: boolean
...@@ -538,7 +539,7 @@ export default class Router implements BaseRouter { ...@@ -538,7 +539,7 @@ export default class Router implements BaseRouter {
private _idx: number = 0 private _idx: number = 0
static events: MittEmitter = mitt() static events: MittEmitter<RouterEvent> = mitt()
constructor( constructor(
pathname: string, pathname: string,
......
...@@ -4,12 +4,16 @@ import Router, { withRouter } from 'next/router' ...@@ -4,12 +4,16 @@ import Router, { withRouter } from 'next/router'
export default withRouter(({ router }) => { export default withRouter(({ router }) => {
React.useEffect(() => { React.useEffect(() => {
Router.events.on('routeChangeComplete', () => {})
//@ts-expect-error
Router.events.on('event', () => {}) Router.events.on('event', () => {})
Router.prefetch('/page') Router.prefetch('/page')
Router.push Router.push
Router.back Router.back
Router.reload Router.reload
router.events.on('routeChangeComplete', () => {})
//@ts-expect-error
router.events.on('event', () => {}) router.events.on('event', () => {})
router.prefetch('/page') router.prefetch('/page')
router.push router.push
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment