fix: correct invalid TS types for router-dependant hooks

vercel · Oct 21, 2022 · 499ab59 · 499ab59
1 parent 1f0f420
commit 499ab59
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 7 deletions.
diff --git a/packages/next/client/components/hooks-client-context.ts b/packages/next/client/components/hooks-client-context.ts
@@ -1,7 +1,7 @@
 import { createContext } from 'react'
 
 export const SearchParamsContext = createContext<URLSearchParams | null>(null)
-export const PathnameContext = createContext<string>(null as any)
+export const PathnameContext = createContext<string | null>(null)
 export const ParamsContext = createContext(null as any)
 export const LayoutSegmentsContext = createContext(null as any)
 

diff --git a/packages/next/client/components/navigation.ts b/packages/next/client/components/navigation.ts
@@ -90,7 +90,10 @@ export function useSearchParams() {
 /**
  * Get the router methods. For example router.push('/dashboard')
  */
-export function useRouter(): import('../../shared/lib/app-router-context').AppRouterInstance {
+export function useRouter():
+  | import('../../shared/lib/app-router-context').AppRouterInstance
+  | null {
+  // TODO-APP: consider throwing an error or adapting this to support pages router
   return useContext(AppRouterContext)
 }
 
@@ -102,7 +105,8 @@ export function useRouter(): import('../../shared/lib/app-router-context').AppRo
 /**
  * Get the current pathname. For example usePathname() on /dashboard?foo=bar would return "/dashboard"
  */
-export function usePathname(): string {
+export function usePathname(): string | null {
+  // TODO-APP: consider throwing an error or adapting this to support pages router
   return useContext(PathnameContext)
 }
 

diff --git a/packages/next/client/router.ts b/packages/next/client/router.ts
@@ -129,7 +129,7 @@ export default singletonRouter as SingletonRouter
 // Reexport the withRoute HOC
 export { default as withRouter } from './with-router'
 
-export function useRouter(): NextRouter {
+export function useRouter(): NextRouter | null {
   return React.useContext(RouterContext)
 }
 

diff --git a/packages/next/shared/lib/app-router-context.ts b/packages/next/shared/lib/app-router-context.ts
@@ -57,8 +57,8 @@ export interface AppRouterInstance {
   prefetch(href: string): void
 }
 
-export const AppRouterContext = React.createContext<AppRouterInstance>(
-  null as any
+export const AppRouterContext = React.createContext<AppRouterInstance | null>(
+  null
 )
 export const LayoutRouterContext = React.createContext<{
   childNodes: CacheNode['parallelRoutes']

diff --git a/packages/next/shared/lib/router-context.ts b/packages/next/shared/lib/router-context.ts
@@ -1,7 +1,7 @@
 import React from 'react'
 import type { NextRouter } from './router/router'
 
-export const RouterContext = React.createContext<NextRouter>(null as any)
+export const RouterContext = React.createContext<NextRouter | null>(null)
 
 if (process.env.NODE_ENV !== 'production') {
   RouterContext.displayName = 'RouterContext'