Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Router

Hierarchy

  • Router

Index

Properties

Accessors

Methods

Properties

restart

restart: (updateHosts?: boolean) => Promise<void>

Type declaration

    • (updateHosts?: boolean): Promise<void>

    • Parameters

      • Optional updateHosts: boolean

      Returns Promise<void>

Accessors

nginxPath

  • get nginxPath(): any

useLaunchd

  • get useLaunchd(): boolean

  • On macOS versions older than Mojave, launchd is required to start up the router so privileged ports such as port 80 and 443 can be used.

    Returns boolean

Static certPaths

  • get certPaths(): any

Static confPath

  • get confPath(): any

Static plistTemplatePath

  • get plistTemplatePath(): any

Static runPath

  • get runPath(): any

Methods

add

  • add(site: Site): Promise<void>

clearRouterBanner

  • clearRouterBanner(): void

doesLaunchdDaemonNeedsReload

  • doesLaunchdDaemonNeedsReload(): boolean

doesNginxNeedBindCap

  • doesNginxNeedBindCap(): boolean

generateRouterLaunchdPlist

  • generateRouterLaunchdPlist(): Promise<string>

getHTTPPortForSite

  • getHTTPPortForSite(site: Site): Local.SitePort | null

getSiteHTTPPortsByDomain

  • getSiteHTTPPortsByDomain(): {}

listen

  • listen(): void

refresh

  • refresh(): Promise<void>

remove

  • remove(domain: any): void

restartLaunchdDaemon

  • restartLaunchdDaemon(force?: boolean): Promise<void>

  • Parameters

    • Optional force: boolean

    Returns Promise<void>

setNginxBindCap

  • setNginxBindCap(): Promise<void>

setRoutingMode

  • setRoutingMode(mode: any, changeDomain?: boolean): void

  • Parameters

    • mode: any
    • Optional changeDomain: boolean

    Returns void

stop

  • stop(): Promise<void>

unloadLaunchdDaemon

  • unloadLaunchdDaemon(): Promise<void>

Generated using TypeDoc