Skip to content

feat: export the StaticRoutes, DynamicRoutes types from 'next' #82955

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

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from
+48 −0
Open

feat: export the StaticRoutes, DynamicRoutes types from 'next' #82955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions packages/next/src/server/lib/router-utils/typegen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,29 @@ declare module 'next' {

export type Route<T extends string = string> =
__next_route_internal_types__.RouteImpl<T>

/**
* All static routes in your application.
* @example
* \`\`\`ts
* import type { StaticRoutes } from 'next'
* const route: StaticRoutes = "/about"
* \`\`\`
*/
export type StaticRoutes = __next_route_internal_types__.StaticRoutes

/**
* All dynamic routes in your application.
*
* The type parameter T represents the union of all possible values that can fill any dynamic segment in your routes.
* @example
* \`\`\`ts
* import type { DynamicRoutes } from 'next'
* // T applies to ALL dynamic segments across ALL routes
* const route: DynamicRoutes<"en" | "fr"> = "/en/about"
* \`\`\`
*/
export type DynamicRoutes<T extends string = string> = __next_route_internal_types__.DynamicRoutes<T>
}

declare module 'next/link' {
Expand Down
25 changes: 25 additions & 0 deletions packages/next/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,31 @@ export type { Instrumentation } from './server/instrumentation/types'
// eslint-disable-next-line @typescript-eslint/no-unused-vars
export type Route<RouteInferType = any> = string & {}

/**
* Stub static routes type before `next dev` or `next build` is run.
* Will be populated with actual static routes during build.
* @example
* ```ts
* import type { StaticRoutes } from 'next'
* const route: StaticRoutes = "/about"
* ```
*/
export type StaticRoutes = never

/**
* Stub dynamic routes type before `next dev` or `next build` is run.
* Will be populated with actual dynamic routes during build.
*
* The type parameter T represents the union of all possible values that can fill any dynamic segment in your routes.
* @example
* ```ts
* import type { DynamicRoutes } from 'next'
* // T applies to ALL dynamic segments across ALL routes
* const route: DynamicRoutes<"en" | "fr"> = "/en/about"
* ```
*/
export type DynamicRoutes<_T extends string = string> = never

// Extend the React types with missing properties
declare module 'react' {
// <html amp=""> support
Expand Down
Loading