resolveHostname() — vite Function Reference

Architecture documentation for the resolveHostname() function in utils.ts from the vite codebase.

Function typescript ViteCore ConfigEngine calls 1 called by 4

Entity Profile

ViteCore→ ConfigEngine→ resolveHostname() — vite Function Reference

Dependency Diagram

graph TD
  369388dc_006d_6dcb_70b4_e174e2ad592f["resolveHostname()"]
  031bc221_67a8_c579_f2bf_bb30a08beeb2["utils.ts"]
  369388dc_006d_6dcb_70b4_e174e2ad592f -->|defined in| 031bc221_67a8_c579_f2bf_bb30a08beeb2
  61b5bb81_ee7e_b41b_377c_aafdae3ef119["resolveDevToolsConfig()"]
  61b5bb81_ee7e_b41b_377c_aafdae3ef119 -->|calls| 369388dc_006d_6dcb_70b4_e174e2ad592f
  3928ac07_6613_c9d3_38dd_625918721277["createClientConfigValueReplacer()"]
  3928ac07_6613_c9d3_38dd_625918721277 -->|calls| 369388dc_006d_6dcb_70b4_e174e2ad592f
  5c50110b_5c76_c14f_b1dd_3efd3df7f375["preview()"]
  5c50110b_5c76_c14f_b1dd_3efd3df7f375 -->|calls| 369388dc_006d_6dcb_70b4_e174e2ad592f
  24ecf2a1_3c09_d451_76f3_9485b4e993f8["_createServer()"]
  24ecf2a1_3c09_d451_76f3_9485b4e993f8 -->|calls| 369388dc_006d_6dcb_70b4_e174e2ad592f
  13a82d8a_e10d_9354_366c_f04ea0cda579["getLocalhostAddressIfDiffersFromDNS()"]
  369388dc_006d_6dcb_70b4_e174e2ad592f -->|calls| 13a82d8a_e10d_9354_366c_f04ea0cda579
  style 369388dc_006d_6dcb_70b4_e174e2ad592f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/vite/src/node/utils.ts lines 956–982

export async function resolveHostname(
  optionsHost: string | boolean | undefined,
): Promise<Hostname> {
  let host: string | undefined
  if (optionsHost === undefined || optionsHost === false) {
    // Use a secure default
    host = 'localhost'
  } else if (optionsHost === true) {
    // If passed --host in the CLI without arguments
    host = undefined // undefined typically means 0.0.0.0 or :: (listen on all IPs)
  } else {
    host = optionsHost
  }

  // Set host name to localhost when possible
  let name = host === undefined || wildcardHosts.has(host) ? 'localhost' : host

  if (host === 'localhost') {
    // See #8647 for more details.
    const localhostAddr = await getLocalhostAddressIfDiffersFromDNS()
    if (localhostAddr) {
      name = localhostAddr
    }
  }

  return { host, name }
}