Class WebServer

Hierarchy

  • WebServer

Constructors

constructor

Properties

XDomain? address? netPort? openPath? staticPath?

Accessors

baseURL openURL

Methods

localHost workerHost getIPA

Constructors

constructor

  • Parameters

    • __namedParameters: {
          XDomain?: boolean;
          netPort?: number;
          openPath?: string | boolean;
          proxyMap?: Record<string, string>;
          staticPath?: string;
      } = {}
      • Optional XDomain?: boolean
      • Optional netPort?: number
      • Optional openPath?: string | boolean
      • Optional proxyMap?: Record<string, string>
      • Optional staticPath?: string

    Returns WebServer

Properties

Optional XDomain

XDomain?: boolean

Optional address

address?: AddressInfo

Optional netPort

netPort?: number

Optional openPath

openPath?: string | boolean

Optional staticPath

staticPath?: string

Accessors

baseURL

  • get baseURL(): string

  • Origin URI

    Returns string

openURL

  • get openURL(): string

  • URL to open in default browser

    Returns string

Methods

localHost

  • Create a server in the same Node.JS process

    Returns Server<typeof IncomingMessage, typeof ServerResponse>

workerHost

  • Boot a server in a forked Node.JS process

    Returns Promise<AddressInfo>

Static getIPA

  • Returns {
        address: string;
        family: string;
    }

    • address: string
    • family: string

Settings

Member Visibility

Theme

Generated using TypeDoc