@tanstack/virtual-file-routes/src/types.ts

Modern and scalable routing for React applications

export type IndexRoute = {
  type: 'index'
  file: string
}

export type LayoutRoute = {
  type: 'layout'
  id?: string
  file: string
  children?: Array<VirtualRouteNode>
}

export type PhysicalSubtree = {
  type: 'physical'
  directory: string
  pathPrefix: string
}

export type Route = {
  type: 'route'
  file?: string
  path: string
  children?: Array<VirtualRouteNode>
}
export type VirtualRouteNode =
  | IndexRoute
  | LayoutRoute
  | Route
  | PhysicalSubtree

export type VirtualRootRoute = {
  type: 'root'
  file: string
  children?: Array<VirtualRouteNode>
}