Home / Function/ baseMiddleware() — vite Function Reference

baseMiddleware() — vite Function Reference

Architecture documentation for the baseMiddleware() function in base.ts from the vite codebase.

Entity Profile

Dependency Diagram

graph TD
  8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e["baseMiddleware()"]
  ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6["base.ts"]
  8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e -->|defined in| ed4cdfe5_4523_9979_979c_b5f6e2b5f2c6
  5c50110b_5c76_c14f_b1dd_3efd3df7f375["preview()"]
  5c50110b_5c76_c14f_b1dd_3efd3df7f375 -->|calls| 8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e
  24ecf2a1_3c09_d451_76f3_9485b4e993f8["_createServer()"]
  24ecf2a1_3c09_d451_76f3_9485b4e993f8 -->|calls| 8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e
  10b9dea8_362c_1af2_93be_afa4dd9aed9e["cleanUrl()"]
  8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e -->|calls| 10b9dea8_362c_1af2_93be_afa4dd9aed9e
  013086ce_01e9_45cb_743f_587baeb03e55["stripBase()"]
  8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e -->|calls| 013086ce_01e9_45cb_743f_587baeb03e55
  1a3bec7b_1a11_316f_5831_a0535b829bbf["withTrailingSlash()"]
  8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e -->|calls| 1a3bec7b_1a11_316f_5831_a0535b829bbf
  c9db8630_93b3_267d_8e26_8b62626a11ca["joinUrlSegments()"]
  8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e -->|calls| c9db8630_93b3_267d_8e26_8b62626a11ca
  style 8e6cd7a2_b085_0a8f_7999_c4deeeb6ef5e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/vite/src/node/server/middlewares/base.ts lines 7–62

export function baseMiddleware(
  rawBase: string,
  middlewareMode: boolean,
): Connect.NextHandleFunction {
  // Keep the named function. The name is visible in debug logs via `DEBUG=connect:dispatcher ...`
  return function viteBaseMiddleware(req, res, next) {
    const url = req.url!
    const pathname = cleanUrl(url)
    const base = rawBase

    if (pathname.startsWith(base)) {
      // rewrite url to remove base. this ensures that other middleware does
      // not need to consider base being prepended or not
      req.url = stripBase(url, base)
      return next()
    }

    // skip redirect and error fallback on middleware mode, #4057
    if (middlewareMode) {
      return next()
    }

    if (pathname === '/' || pathname === '/index.html') {
      // redirect root visit to based url with search and hash
      res.writeHead(302, {
        Location: base + url.slice(pathname.length),
      })
      res.end()
      return
    }

    // non-based page visit
    const redirectPath =
      withTrailingSlash(url) !== base ? joinUrlSegments(base, url) : base
    if (req.headers.accept?.includes('text/html')) {
      res.writeHead(404, {
        'Content-Type': 'text/html',
      })
      res.end(
        `The server is configured with a public base URL of ${base} - ` +
          `did you mean to visit <a href="${redirectPath}">${redirectPath}</a> instead?`,
      )
      return
    } else {
      // not found for resources
      res.writeHead(404, {
        'Content-Type': 'text/plain',
      })
      res.end(
        `The server is configured with a public base URL of ${base} - ` +
          `did you mean to visit ${redirectPath} instead?`,
      )
      return
    }
  }
}

Domain

Subdomains

Frequently Asked Questions

What does baseMiddleware() do?
baseMiddleware() is a function in the vite codebase, defined in packages/vite/src/node/server/middlewares/base.ts.
Where is baseMiddleware() defined?
baseMiddleware() is defined in packages/vite/src/node/server/middlewares/base.ts at line 7.
What does baseMiddleware() call?
baseMiddleware() calls 4 function(s): cleanUrl, joinUrlSegments, stripBase, withTrailingSlash.
What calls baseMiddleware()?
baseMiddleware() is called by 2 function(s): _createServer, preview.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free