Variable networkConst

Type Declaration

• dialTCP: function

  • dialTCP(addr: string): Promise<Connection>

    Open a raw TCP connection through the Tailscale network. Returns a Connection object for sending and receiving data.

    Parameters

    • addr: string

    Returns Promise<Connection>

    Example

    const conn = await network.dialTCP("my-server:8080")
    
    conn.onData(data => {
      console.log(new TextDecoder().decode(data))
    })
    
    conn.write("hello\n")
    conn.close()
    Copy

• fetch: function

  • fetch(url: string, init?: RequestInit): Promise<Response>

    Make an HTTP request through the Tailscale network. Supports method, headers, and body. Does not yet support AbortSignal, streaming bodies or responses, or other advanced Fetch API options.

    Parameters

    • url: string
    • init: RequestInit = {}

    Returns Promise<Response>

    Example

    const resp = await network.fetch("https://internal-service/api", {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({ key: "value" }),
    })
    console.log(resp.status, resp.ok)
    const data = await resp.json()
    Copy

• getDNS: function

  • getDNS(): DNSInfo

    Return the current Tailscale-managed DNS configuration. Synchronous — no await needed. Returns an empty DNSInfo object if called before init() resolves.

    Returns DNSInfo

    Example

    const dns = network.getDNS()
    console.log("resolvers:", dns.resolvers)
    console.log("MagicDNS:", dns.magicDNS)
    for (const [suffix, resolvers] of Object.entries(dns.routes)) {
      console.log(`split-DNS: ${suffix} → ${resolvers.join(", ")}`)
    }
    Copy

• getPrefs: function

  • getPrefs(): Prefs

    Return the current preferences (acceptRoutes, exitNodeId). Synchronous — no await needed. Must be called after init() resolves.

    Returns Prefs

    Example

    const { acceptRoutes, exitNodeId } = network.getPrefs()
    console.log("exit node:", exitNodeId || "(none)")
    Copy

• getRoutes: function

  • getRoutes(): Route[]

    Return the full routing table (self + all peers). Synchronous — no await needed. Returns an empty array if called before init() resolves.

    Returns Route[]

    Example

    const routes = network.getRoutes()
    for (const r of routes) {
      console.log(r.prefix, "via", r.via, r.isExitRoute ? "(exit)" : "")
    }
    Copy

• init: function

  • init(options?: InitOptions): Promise<void>

    Initialize and connect the Tailscale node. Must be called before any other method. Resolves once the node is authenticated and ready.

    If the node has persisted state from a previous session it reconnects automatically. Otherwise the OAuth flow is triggered via onAuthRequired. Rejects if the auth URL does not arrive within 60 seconds, or if the user does not complete authentication within 5 minutes.

    Parameters

    • options: InitOptions = {}

    Returns Promise<void>

    Example

    await network.init({
      hostname: "my-app",
      onAuthRequired(url) {
        window.open(url, "_blank", "width=600,height=700")
      },
      onAuthComplete() {
        console.log("connected!")
      },
    })
    Copy

    Example

    // Custom storage backend (e.g. sessionStorage or any key/value store)
    await network.init({
      hostname: "my-app",
      storage: {
        get: key => sessionStorage.getItem(key),
        set: (key, val) => sessionStorage.setItem(key, val),
      },
      onAuthRequired(url) { console.log("Authenticate at:", url) },
    })
    Copy

• listenTCP: function

  • listenTCP(
        port?: number,
        onConnection: (conn: Connection) => void,
    ): Promise<Listener>

    Listen for inbound TCP connections on the given Tailscale port. Pass port 0 (default) to get an ephemeral port assigned automatically. onConnection is called for each accepted connection. Returns a Listener with the assigned port number and a close() method.

    Parameters

    • port: number = 0
    • onConnection: (conn: Connection) => void

    Returns Promise<Listener>

    Example

    const listener = await network.listenTCP(8080, conn => {
      conn.onData(data => console.log(new TextDecoder().decode(data)))
      conn.write("hello\n")
    })
    console.log("listening on port", listener.port)
    Copy

    Example

    // Ephemeral port
    const listener = await network.listenTCP(0, conn => { conn.close() })
    console.log("assigned port:", listener.port)
    listener.close()
    Copy

• listExitNodes: function

  • listExitNodes(): ExitNode[]

    Return all peers that advertise exit-node capability. Synchronous — no await needed. Returns an empty array if called before init() resolves.

    Returns ExitNode[]

    Example

    const nodes = network.listExitNodes()
    for (const n of nodes) {
      console.log(n.hostName, n.tailscaleIP, n.online ? "online" : "offline")
    }
    Copy

• localIPv4: function

  • localIPv4(): string

    Return this node's Tailscale IPv4 address, or an empty string if not yet assigned. Synchronous — no await needed. Must be called after init() resolves.

    Returns string

• localIPv6: function

  • localIPv6(): string

    Return this node's Tailscale IPv6 address, or an empty string if not yet assigned. Synchronous — no await needed. Must be called after init() resolves.

    Returns string

• ping: function

  • ping(addr: string): Promise<PingResult>

    Send an ICMP ping to addr and measure round-trip time. addr may be a hostname or Tailscale IP.

    Parameters

    • addr: string

    Returns Promise<PingResult>

    Example

    const result = await network.ping("my-server")
    if (result.alive) {
      console.log(`rtt: ${result.rttMs.toFixed(3)} ms  ip: ${result.nodeIP}`)
    } else {
      console.warn("unreachable:", result.err)
    }
    Copy

• setAcceptRoutes: function

  • setAcceptRoutes(accept: boolean): Promise<void>

    Enable or disable acceptance of subnet routes advertised by peers. Equivalent to tailscale set --accept-routes.

    Parameters

    • accept: boolean

    Returns Promise<void>

    Example

    await network.setAcceptRoutes(true)
    Copy

• setExitNode: function

  • setExitNode(id?: string): Promise<void>

    Activate an exit node by its stable node ID. Pass an empty string (or omit) to clear the exit node.

    Parameters

    • id: string = ""

    Returns Promise<void>

    Example

    // Activate the first available online exit node
    const node = network.listExitNodes().find(n => n.online)
    if (node) await network.setExitNode(node.id)
    Copy

    Example

    // Clear the active exit node
    await network.setExitNode()
    Copy