startedOnPort() — vite Function Reference

Architecture documentation for the startedOnPort() function in serve.ts from the vite codebase.

Function typescript ViteCore ConfigEngine calls 1 called by 1

Entity Profile

ViteCore→ ConfigEngine→ startedOnPort() — vite Function Reference

Dependency Diagram

graph TD
  d506bfe8_68fa_566f_ee31_a95ce550afe2["startedOnPort()"]
  ef6fee49_c1b8_1e5b_85c2_51741ccb23ee["serve.ts"]
  d506bfe8_68fa_566f_ee31_a95ce550afe2 -->|defined in| ef6fee49_c1b8_1e5b_85c2_51741ccb23ee
  86a345b3_7adf_2ef5_2653_e31a0ea82441["serve()"]
  86a345b3_7adf_2ef5_2653_e31a0ea82441 -->|calls| d506bfe8_68fa_566f_ee31_a95ce550afe2
  dd2cca78_5ee5_7c7d_1f8e_30c4c0d424e7["resolvedOrTimeout()"]
  d506bfe8_68fa_566f_ee31_a95ce550afe2 -->|calls| dd2cca78_5ee5_7c7d_1f8e_30c4c0d424e7
  style d506bfe8_68fa_566f_ee31_a95ce550afe2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

playground/cli/__tests__/serve.ts lines 120–145

async function startedOnPort(serverProcess, port, timeout) {
  let checkPort
  const startedPromise = new Promise<void>((resolve, reject) => {
    checkPort = (data) => {
      const str = stripVTControlCharacters(data.toString())
      const match = str.match(
        /http:\/\/(?:localhost|127\.0\.0\.1|\[::1\]):(\d{4})/,
      )
      if (match) {
        const startedPort = parseInt(match[1], 10)
        if (startedPort === port) {
          resolve()
        } else {
          const msg = `server listens on port ${startedPort} instead of ${port}`
          reject(msg)
        }
      }
    }
    serverProcess.stdout.on('data', checkPort)
  })
  return resolvedOrTimeout(
    startedPromise,
    timeout,
    `failed to start within ${timeout}ms`,
  ).finally(() => serverProcess.stdout.off('data', checkPort))
}