Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Server

Index

Constructors

Properties

options: Configuration
server: undefined | null | Server<typeof IncomingMessage, typeof ServerResponse>
sockets: Socket[]
staticWatchers: FSWatcher[]
webSocketServer: undefined | null | WebSocketServerImplementation

Accessors

  • get cli(): { getArguments: any; processArguments: any }
  • Returns { getArguments: any; processArguments: any }

    • getArguments:function
      • getArguments(): { allowed-hosts: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }; allowed-hosts-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; bonjour: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string; values: boolean[] }[]; description: string; multiple: boolean; simpleType: string }; client-logging: { configs: { description: string; multiple: boolean; path: string; type: string; values: string[] }[]; description: string; multiple: boolean; simpleType: string }; client-overlay: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-overlay-errors: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-overlay-trusted-types-policy-name: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-overlay-warnings: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-progress: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-reconnect: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-transport: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-hostname: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-password: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-pathname: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-port: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-protocol: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-username: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; compress: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; history-api-fallback: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; host: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; hot: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }; http2: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-ca: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-ca-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-cacert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-cacert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-cert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-cert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-crl: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-crl-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-key: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-key-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-passphrase: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-pfx: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-pfx-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-request-cert: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; ipc: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: boolean[] })[]; description: string; multiple: boolean; simpleType: string }; live-reload: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; magic-html: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; negatedDescription: string; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; open-app: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-app-name: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-app-name-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-target: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-target-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; port: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }; server-options-ca: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-ca-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-cacert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-cacert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-cert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-cert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-crl: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-crl-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-key: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-key-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-passphrase: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-pfx: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-pfx-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-request-cert: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-type: { configs: { description: string; multiple: boolean; path: string; type: string; values: string[] }[]; description: string; multiple: boolean; simpleType: string }; static: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; negatedDescription: string; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; static-directory: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-public-path: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-public-path-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-serve-index: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-watch: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; watch-files: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; watch-files-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; web-socket-server: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string; values: boolean[] } | { description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; web-socket-server-type: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string } }
      • Returns { allowed-hosts: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }; allowed-hosts-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; bonjour: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string; values: boolean[] }[]; description: string; multiple: boolean; simpleType: string }; client-logging: { configs: { description: string; multiple: boolean; path: string; type: string; values: string[] }[]; description: string; multiple: boolean; simpleType: string }; client-overlay: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-overlay-errors: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-overlay-trusted-types-policy-name: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-overlay-warnings: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-progress: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-reconnect: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-transport: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-hostname: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-password: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-pathname: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-port: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-protocol: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; client-web-socket-url-username: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; compress: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; history-api-fallback: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; host: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; hot: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }; http2: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-ca: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-ca-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-cacert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-cacert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-cert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-cert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-crl: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-crl-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-key: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-key-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-passphrase: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-pfx: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-pfx-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; https-request-cert: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; ipc: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: boolean[] })[]; description: string; multiple: boolean; simpleType: string }; live-reload: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; magic-html: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; negatedDescription: string; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; open-app: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-app-name: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-app-name-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-target: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; open-target-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; port: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }; server-options-ca: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-ca-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-cacert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-cacert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-cert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-cert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-crl: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-crl-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-key: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-key-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-passphrase: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-pfx: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-pfx-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-options-request-cert: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; server-type: { configs: { description: string; multiple: boolean; path: string; type: string; values: string[] }[]; description: string; multiple: boolean; simpleType: string }; static: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; negatedDescription: string; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; static-directory: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-public-path: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-public-path-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-serve-index: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; static-watch: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; watch-files: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; watch-files-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }; web-socket-server: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string; values: boolean[] } | { description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }; web-socket-server-type: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string } }

        • allowed-hosts: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]
          • description: string
          • multiple: boolean
            property

            {boolean | string} [ipc]

            property

            {Host} [host]

            property

            {Port} [port]

            property

            {boolean | "only"} [hot]

            property

            {boolean} [liveReload]

            property

            {DevMiddlewareOptions<Request, Response>} [devMiddleware]

            property

            {boolean} [compress]

            property

            {boolean} [magicHtml]

            property

            {"auto" | "all" | string | string[]} [allowedHosts]

            property

            {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]

            property

            {boolean} [setupExitSignals]

            property

            {boolean | Record<string, never> | BonjourOptions} [bonjour]

            property

            {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]

            property

            {boolean | string | Static | Array<string | Static>} [static]

            property

            {boolean | ServerOptions} [https]

            property

            {boolean} [http2]

            property

            {"http" | "https" | "spdy" | string | ServerConfiguration} [server]

            property

            {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]

            property

            {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]

            property

            {boolean | string | Open | Array<string | Open>} [open]

            property

            {boolean} [setupExitSignals]

            property

            {boolean | ClientConfiguration} [client]

            property

            {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]

            property

            {(devServer: Server) => void} [onAfterSetupMiddleware]

            property

            {(devServer: Server) => void} [onBeforeSetupMiddleware]

            property

            {(devServer: Server) => void} [onListening]

            property

            {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]

          • simpleType: string
        • allowed-hosts-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • bonjour: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string; values: boolean[] }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string; values: boolean[] }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-logging: { configs: { description: string; multiple: boolean; path: string; type: string; values: string[] }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string; values: string[] }[]
            property

            {boolean | string} [ipc]

            property

            {Host} [host]

            property

            {Port} [port]

            property

            {boolean | "only"} [hot]

            property

            {boolean} [liveReload]

            property

            {DevMiddlewareOptions<Request, Response>} [devMiddleware]

            property

            {boolean} [compress]

            property

            {boolean} [magicHtml]

            property

            {"auto" | "all" | string | string[]} [allowedHosts]

            property

            {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]

            property

            {boolean} [setupExitSignals]

            property

            {boolean | Record<string, never> | BonjourOptions} [bonjour]

            property

            {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]

            property

            {boolean | string | Static | Array<string | Static>} [static]

            property

            {boolean | ServerOptions} [https]

            property

            {boolean} [http2]

            property

            {"http" | "https" | "spdy" | string | ServerConfiguration} [server]

            property

            {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]

            property

            {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]

            property

            {boolean | string | Open | Array<string | Open>} [open]

            property

            {boolean} [setupExitSignals]

            property

            {boolean | ClientConfiguration} [client]

            property

            {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]

            property

            {(devServer: Server) => void} [onAfterSetupMiddleware]

            property

            {(devServer: Server) => void} [onBeforeSetupMiddleware]

            property

            {(devServer: Server) => void} [onListening]

            property

            {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]

          • description: string
          • multiple: boolean
          • simpleType: string
        • client-overlay: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-overlay-errors: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-overlay-trusted-types-policy-name: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-overlay-warnings: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-progress: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-reconnect: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }
          property

          {boolean | string} [ipc]

          property

          {Host} [host]

          property

          {Port} [port]

          property

          {boolean | "only"} [hot]

          property

          {boolean} [liveReload]

          property

          {DevMiddlewareOptions<Request, Response>} [devMiddleware]

          property

          {boolean} [compress]

          property

          {boolean} [magicHtml]

          property

          {"auto" | "all" | string | string[]} [allowedHosts]

          property

          {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]

          property

          {boolean} [setupExitSignals]

          property

          {boolean | Record<string, never> | BonjourOptions} [bonjour]

          property

          {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]

          property

          {boolean | string | Static | Array<string | Static>} [static]

          property

          {boolean | ServerOptions} [https]

          property

          {boolean} [http2]

          property

          {"http" | "https" | "spdy" | string | ServerConfiguration} [server]

          property

          {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]

          property

          {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]

          property

          {boolean | string | Open | Array<string | Open>} [open]

          property

          {boolean} [setupExitSignals]

          property

          {boolean | ClientConfiguration} [client]

          property

          {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]

          property

          {(devServer: Server) => void} [onAfterSetupMiddleware]

          property

          {(devServer: Server) => void} [onBeforeSetupMiddleware]

          property

          {(devServer: Server) => void} [onListening]

          property

          {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]

          • configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-web-socket-transport: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-web-socket-url: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-web-socket-url-hostname: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-web-socket-url-password: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-web-socket-url-pathname: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-web-socket-url-port: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-web-socket-url-protocol: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • client-web-socket-url-username: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • compress: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          param URL
          returns
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
            param gateway
            returns
          • simpleType: string
        • history-api-fallback: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • host: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]
          • description: string
          • multiple: boolean
            param hostname
            returns
          • simpleType: string
        • hot: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • http2: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-ca: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-ca-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-cacert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-cacert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-cert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-cert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-crl: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-crl-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-key: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-key-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-passphrase: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-pfx: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-pfx-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • https-request-cert: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • ipc: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: boolean[] })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: boolean[] })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • live-reload: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • magic-html: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • open: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; negatedDescription: string; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; negatedDescription: string; path: string; type: string })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • open-app: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • open-app-name: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • open-app-name-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • open-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • open-target: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • open-target-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • port: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; path: string; type: string; values: string[] })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-ca: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-ca-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-cacert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-cacert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-cert: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-cert-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-crl: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-crl-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-key: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-key-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-passphrase: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-pfx: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-pfx-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-options-request-cert: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • server-type: { configs: { description: string; multiple: boolean; path: string; type: string; values: string[] }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string; values: string[] }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • static: { configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; negatedDescription: string; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string } | { description: string; multiple: boolean; negatedDescription: string; path: string; type: string })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • static-directory: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
            param item
            returns
          • multiple: boolean
          • simpleType: string
        • static-public-path: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • static-public-path-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • static-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • static-serve-index: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • static-watch: { configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; negatedDescription: string; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • watch-files: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • watch-files-reset: { configs: { description: string; multiple: boolean; path: string; type: string }[]; description: string; multiple: boolean; simpleType: string }
          • configs: { description: string; multiple: boolean; path: string; type: string }[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • web-socket-server: { configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string; values: boolean[] } | { description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; negatedDescription: string; path: string; type: string; values: boolean[] } | { description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]
          • description: string
          • multiple: boolean
          • simpleType: string
        • web-socket-server-type: { configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]; description: string; multiple: boolean; simpleType: string }
          • configs: ({ description: string; multiple: boolean; path: string; type: string; values: string[] } | { description: string; multiple: boolean; path: string; type: string })[]
          • description: string
          • multiple: boolean
          • simpleType: string
    • processArguments:function
      • processArguments(args: Record<string, Argument>, config: any, values: Record<string, string | number | boolean | RegExp | (string | number | boolean | RegExp)[]>): null | Problem[]
      • Parameters

        • args: Record<string, Argument>
        • config: any
        • values: Record<string, string | number | boolean | RegExp | (string | number | boolean | RegExp)[]>

        Returns null | Problem[]

  • get schema(): { additionalProperties: boolean; definitions: { AllowedHosts: { anyOf: ({ $ref?: undefined; enum?: undefined; items: { $ref: string }; minItems: number; type: string } | { $ref?: undefined; enum: string[]; items?: undefined; minItems?: undefined; type?: undefined } | { $ref: string; enum?: undefined; items?: undefined; minItems?: undefined; type?: undefined })[]; description: string; link: string }; AllowedHostsItem: { minLength: number; type: string }; Bonjour: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }; Client: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; enum: boolean[]; properties?: undefined; type?: undefined } | { additionalProperties: boolean; cli?: undefined; enum?: undefined; properties: { logging: { $ref: string }; overlay: { $ref: string }; progress: { $ref: string }; reconnect: { $ref: string }; webSocketTransport: { $ref: string }; webSocketURL: { $ref: string } }; type: string })[]; description: string; link: string }; ClientLogging: { description: string; enum: string[]; link: string }; ClientOverlay: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; description: string; link: string; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; description?: undefined; link?: undefined; properties: { errors: { cli: { negatedDescription: string }; description: string; type: string }; trustedTypesPolicyName: { description: string; type: string }; warnings: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[] }; ClientProgress: { cli: { negatedDescription: string }; description: string; link: string; type: string }; ClientReconnect: { anyOf: ({ cli: { negatedDescription: string }; minimum?: undefined; type: string } | { cli?: undefined; minimum: number; type: string })[]; description: string; link: string }; ClientWebSocketTransport: { anyOf: { $ref: string }[]; description: string; link: string }; ClientWebSocketTransportEnum: { enum: string[] }; ClientWebSocketTransportString: { minLength: number; type: string }; ClientWebSocketURL: { anyOf: ({ additionalProperties?: undefined; minLength: number; properties?: undefined; type: string } | { additionalProperties: boolean; minLength?: undefined; properties: { hostname: { description: string; minLength: number; type: string }; password: { description: string; type: string }; pathname: { description: string; type: string }; port: { anyOf: ({ minLength?: undefined; type: string } | { minLength: number; type: string })[]; description: string }; protocol: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string }; username: { description: string; type: string } }; type: string })[]; description: string; link: string }; Compress: { cli: { negatedDescription: string }; description: string; link: string; type: string }; DevMiddleware: { additionalProperties: boolean; description: string; link: string; type: string }; HTTP2: { cli: { negatedDescription: string }; description: string; link: string; type: string }; HTTPS: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[]; description: string; link: string }; HeaderObject: { additionalProperties: boolean; cli: { exclude: boolean }; properties: { key: { description: string; type: string }; value: { description: string; type: string } }; type: string }; Headers: { anyOf: ({ instanceof?: undefined; items: { $ref: string }; minItems: number; type: string } | { instanceof?: undefined; items?: undefined; minItems?: undefined; type: string } | { instanceof: string; items?: undefined; minItems?: undefined; type?: undefined })[]; description: string; link: string }; HistoryApiFallback: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }; Host: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string; link: string }; Hot: { anyOf: ({ cli: { negatedDescription: string }; enum?: undefined; type: string } | { cli?: undefined; enum: string[]; type?: undefined })[]; description: string; link: string }; IPC: { anyOf: ({ enum?: undefined; minLength: number; type: string } | { enum: boolean[]; minLength?: undefined; type: string })[]; description: string; link: string }; LiveReload: { cli: { negatedDescription: string }; description: string; link: string; type: string }; MagicHTML: { cli: { negatedDescription: string }; description: string; link: string; type: string }; OnAfterSetupMiddleware: { description: string; instanceof: string; link: string }; OnBeforeSetupMiddleware: { description: string; instanceof: string; link: string }; OnListening: { description: string; instanceof: string; link: string }; Open: { anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]; description: string; link: string }; OpenBoolean: { cli: { negatedDescription: string }; type: string }; OpenObject: { additionalProperties: boolean; properties: { app: { anyOf: ({ additionalProperties: boolean; cli?: undefined; description?: undefined; minLength?: undefined; properties: { arguments: { items: { minLength: number; type: string } }; name: { anyOf: ({ items: { minLength: number; type: string }; minItems: number; minLength?: undefined; type: string } | { items?: undefined; minItems?: undefined; minLength: number; type: string })[] } }; type: string } | { additionalProperties?: undefined; cli: { description: string }; description: string; minLength: number; properties?: undefined; type: string })[]; description: string }; target: { anyOf: ({ items: { type: string }; type: string } | { items?: undefined; type: string })[]; description: string } }; type: string }; OpenString: { minLength: number; type: string }; Port: { anyOf: ({ enum?: undefined; maximum: number; minLength?: undefined; minimum: number; type: string } | { enum?: undefined; maximum?: undefined; minLength: number; minimum?: undefined; type: string } | { enum: string[]; maximum?: undefined; minLength?: undefined; minimum?: undefined; type?: undefined })[]; description: string; link: string }; Proxy: { anyOf: ({ items?: undefined; type: string } | { items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string })[]; description: string; link: string }; Server: { anyOf: { $ref: string }[]; description: string; link: string }; ServerEnum: { cli: { exclude: boolean }; enum: string[] }; ServerObject: { additionalProperties: boolean; properties: { options: { $ref: string }; type: { anyOf: { $ref: string }[] } }; type: string }; ServerOptions: { additionalProperties: boolean; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string }; ServerString: { cli: { exclude: boolean }; minLength: number; type: string }; ServerType: { enum: string[] }; SetupExitSignals: { cli: { exclude: boolean }; description: string; link: string; type: string }; SetupMiddlewares: { description: string; instanceof: string; link: string }; Static: { anyOf: ({ $ref?: undefined; cli?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref?: undefined; cli: { negatedDescription: string }; items?: undefined; type: string } | { $ref: string; cli?: undefined; items?: undefined; type?: undefined })[]; description: string; link: string }; StaticObject: { additionalProperties: boolean; properties: { directory: { description: string; link: string; minLength: number; type: string }; publicPath: { anyOf: ({ items: { type: string }; minItems: number; type: string } | { items?: undefined; minItems?: undefined; type: string })[]; description: string; link: string }; serveIndex: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; type: string } | { additionalProperties: boolean; cli?: undefined; type: string })[]; description: string; link: string }; staticOptions: { additionalProperties: boolean; link: string; type: string }; watch: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string } }; type: string }; StaticString: { minLength: number; type: string }; WatchFiles: { anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]; description: string; link: string }; WatchFilesObject: { additionalProperties: boolean; cli: { exclude: boolean }; properties: { options: { additionalProperties: boolean; description: string; link: string; type: string }; paths: { anyOf: ({ items: { minLength: number; type: string }; minLength?: undefined; type: string } | { items?: undefined; minLength: number; type: string })[]; description: string } }; type: string }; WatchFilesString: { minLength: number; type: string }; WebSocketServer: { anyOf: { $ref: string }[]; description: string; link: string }; WebSocketServerEnum: { anyOf: ({ $ref?: undefined; cli: { negatedDescription: string }; enum: boolean[] } | { $ref: string; cli?: undefined; enum?: undefined })[]; cli: { description: string } }; WebSocketServerFunction: { instanceof: string }; WebSocketServerObject: { additionalProperties: boolean; properties: { options: { additionalProperties: boolean; cli: { exclude: boolean }; type: string }; type: { anyOf: { $ref: string }[] } }; type: string }; WebSocketServerString: { minLength: number; type: string }; WebSocketServerType: { enum: string[] } }; properties: { allowedHosts: { $ref: string }; bonjour: { $ref: string }; client: { $ref: string }; compress: { $ref: string }; devMiddleware: { $ref: string }; headers: { $ref: string }; historyApiFallback: { $ref: string }; host: { $ref: string }; hot: { $ref: string }; http2: { $ref: string }; https: { $ref: string }; ipc: { $ref: string }; liveReload: { $ref: string }; magicHtml: { $ref: string }; onAfterSetupMiddleware: { $ref: string }; onBeforeSetupMiddleware: { $ref: string }; onListening: { $ref: string }; open: { $ref: string }; port: { $ref: string }; proxy: { $ref: string }; server: { $ref: string }; setupExitSignals: { $ref: string }; setupMiddlewares: { $ref: string }; static: { $ref: string }; watchFiles: { $ref: string }; webSocketServer: { $ref: string } }; title: string; type: string }
  • Returns { additionalProperties: boolean; definitions: { AllowedHosts: { anyOf: ({ $ref?: undefined; enum?: undefined; items: { $ref: string }; minItems: number; type: string } | { $ref?: undefined; enum: string[]; items?: undefined; minItems?: undefined; type?: undefined } | { $ref: string; enum?: undefined; items?: undefined; minItems?: undefined; type?: undefined })[]; description: string; link: string }; AllowedHostsItem: { minLength: number; type: string }; Bonjour: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }; Client: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; enum: boolean[]; properties?: undefined; type?: undefined } | { additionalProperties: boolean; cli?: undefined; enum?: undefined; properties: { logging: { $ref: string }; overlay: { $ref: string }; progress: { $ref: string }; reconnect: { $ref: string }; webSocketTransport: { $ref: string }; webSocketURL: { $ref: string } }; type: string })[]; description: string; link: string }; ClientLogging: { description: string; enum: string[]; link: string }; ClientOverlay: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; description: string; link: string; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; description?: undefined; link?: undefined; properties: { errors: { cli: { negatedDescription: string }; description: string; type: string }; trustedTypesPolicyName: { description: string; type: string }; warnings: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[] }; ClientProgress: { cli: { negatedDescription: string }; description: string; link: string; type: string }; ClientReconnect: { anyOf: ({ cli: { negatedDescription: string }; minimum?: undefined; type: string } | { cli?: undefined; minimum: number; type: string })[]; description: string; link: string }; ClientWebSocketTransport: { anyOf: { $ref: string }[]; description: string; link: string }; ClientWebSocketTransportEnum: { enum: string[] }; ClientWebSocketTransportString: { minLength: number; type: string }; ClientWebSocketURL: { anyOf: ({ additionalProperties?: undefined; minLength: number; properties?: undefined; type: string } | { additionalProperties: boolean; minLength?: undefined; properties: { hostname: { description: string; minLength: number; type: string }; password: { description: string; type: string }; pathname: { description: string; type: string }; port: { anyOf: ({ minLength?: undefined; type: string } | { minLength: number; type: string })[]; description: string }; protocol: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string }; username: { description: string; type: string } }; type: string })[]; description: string; link: string }; Compress: { cli: { negatedDescription: string }; description: string; link: string; type: string }; DevMiddleware: { additionalProperties: boolean; description: string; link: string; type: string }; HTTP2: { cli: { negatedDescription: string }; description: string; link: string; type: string }; HTTPS: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[]; description: string; link: string }; HeaderObject: { additionalProperties: boolean; cli: { exclude: boolean }; properties: { key: { description: string; type: string }; value: { description: string; type: string } }; type: string }; Headers: { anyOf: ({ instanceof?: undefined; items: { $ref: string }; minItems: number; type: string } | { instanceof?: undefined; items?: undefined; minItems?: undefined; type: string } | { instanceof: string; items?: undefined; minItems?: undefined; type?: undefined })[]; description: string; link: string }; HistoryApiFallback: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }; Host: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string; link: string }; Hot: { anyOf: ({ cli: { negatedDescription: string }; enum?: undefined; type: string } | { cli?: undefined; enum: string[]; type?: undefined })[]; description: string; link: string }; IPC: { anyOf: ({ enum?: undefined; minLength: number; type: string } | { enum: boolean[]; minLength?: undefined; type: string })[]; description: string; link: string }; LiveReload: { cli: { negatedDescription: string }; description: string; link: string; type: string }; MagicHTML: { cli: { negatedDescription: string }; description: string; link: string; type: string }; OnAfterSetupMiddleware: { description: string; instanceof: string; link: string }; OnBeforeSetupMiddleware: { description: string; instanceof: string; link: string }; OnListening: { description: string; instanceof: string; link: string }; Open: { anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]; description: string; link: string }; OpenBoolean: { cli: { negatedDescription: string }; type: string }; OpenObject: { additionalProperties: boolean; properties: { app: { anyOf: ({ additionalProperties: boolean; cli?: undefined; description?: undefined; minLength?: undefined; properties: { arguments: { items: { minLength: number; type: string } }; name: { anyOf: ({ items: { minLength: number; type: string }; minItems: number; minLength?: undefined; type: string } | { items?: undefined; minItems?: undefined; minLength: number; type: string })[] } }; type: string } | { additionalProperties?: undefined; cli: { description: string }; description: string; minLength: number; properties?: undefined; type: string })[]; description: string }; target: { anyOf: ({ items: { type: string }; type: string } | { items?: undefined; type: string })[]; description: string } }; type: string }; OpenString: { minLength: number; type: string }; Port: { anyOf: ({ enum?: undefined; maximum: number; minLength?: undefined; minimum: number; type: string } | { enum?: undefined; maximum?: undefined; minLength: number; minimum?: undefined; type: string } | { enum: string[]; maximum?: undefined; minLength?: undefined; minimum?: undefined; type?: undefined })[]; description: string; link: string }; Proxy: { anyOf: ({ items?: undefined; type: string } | { items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string })[]; description: string; link: string }; Server: { anyOf: { $ref: string }[]; description: string; link: string }; ServerEnum: { cli: { exclude: boolean }; enum: string[] }; ServerObject: { additionalProperties: boolean; properties: { options: { $ref: string }; type: { anyOf: { $ref: string }[] } }; type: string }; ServerOptions: { additionalProperties: boolean; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string }; ServerString: { cli: { exclude: boolean }; minLength: number; type: string }; ServerType: { enum: string[] }; SetupExitSignals: { cli: { exclude: boolean }; description: string; link: string; type: string }; SetupMiddlewares: { description: string; instanceof: string; link: string }; Static: { anyOf: ({ $ref?: undefined; cli?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref?: undefined; cli: { negatedDescription: string }; items?: undefined; type: string } | { $ref: string; cli?: undefined; items?: undefined; type?: undefined })[]; description: string; link: string }; StaticObject: { additionalProperties: boolean; properties: { directory: { description: string; link: string; minLength: number; type: string }; publicPath: { anyOf: ({ items: { type: string }; minItems: number; type: string } | { items?: undefined; minItems?: undefined; type: string })[]; description: string; link: string }; serveIndex: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; type: string } | { additionalProperties: boolean; cli?: undefined; type: string })[]; description: string; link: string }; staticOptions: { additionalProperties: boolean; link: string; type: string }; watch: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string } }; type: string }; StaticString: { minLength: number; type: string }; WatchFiles: { anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]; description: string; link: string }; WatchFilesObject: { additionalProperties: boolean; cli: { exclude: boolean }; properties: { options: { additionalProperties: boolean; description: string; link: string; type: string }; paths: { anyOf: ({ items: { minLength: number; type: string }; minLength?: undefined; type: string } | { items?: undefined; minLength: number; type: string })[]; description: string } }; type: string }; WatchFilesString: { minLength: number; type: string }; WebSocketServer: { anyOf: { $ref: string }[]; description: string; link: string }; WebSocketServerEnum: { anyOf: ({ $ref?: undefined; cli: { negatedDescription: string }; enum: boolean[] } | { $ref: string; cli?: undefined; enum?: undefined })[]; cli: { description: string } }; WebSocketServerFunction: { instanceof: string }; WebSocketServerObject: { additionalProperties: boolean; properties: { options: { additionalProperties: boolean; cli: { exclude: boolean }; type: string }; type: { anyOf: { $ref: string }[] } }; type: string }; WebSocketServerString: { minLength: number; type: string }; WebSocketServerType: { enum: string[] } }; properties: { allowedHosts: { $ref: string }; bonjour: { $ref: string }; client: { $ref: string }; compress: { $ref: string }; devMiddleware: { $ref: string }; headers: { $ref: string }; historyApiFallback: { $ref: string }; host: { $ref: string }; hot: { $ref: string }; http2: { $ref: string }; https: { $ref: string }; ipc: { $ref: string }; liveReload: { $ref: string }; magicHtml: { $ref: string }; onAfterSetupMiddleware: { $ref: string }; onBeforeSetupMiddleware: { $ref: string }; onListening: { $ref: string }; open: { $ref: string }; port: { $ref: string }; proxy: { $ref: string }; server: { $ref: string }; setupExitSignals: { $ref: string }; setupMiddlewares: { $ref: string }; static: { $ref: string }; watchFiles: { $ref: string }; webSocketServer: { $ref: string } }; title: string; type: string }

    • additionalProperties: boolean
    • definitions: { AllowedHosts: { anyOf: ({ $ref?: undefined; enum?: undefined; items: { $ref: string }; minItems: number; type: string } | { $ref?: undefined; enum: string[]; items?: undefined; minItems?: undefined; type?: undefined } | { $ref: string; enum?: undefined; items?: undefined; minItems?: undefined; type?: undefined })[]; description: string; link: string }; AllowedHostsItem: { minLength: number; type: string }; Bonjour: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }; Client: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; enum: boolean[]; properties?: undefined; type?: undefined } | { additionalProperties: boolean; cli?: undefined; enum?: undefined; properties: { logging: { $ref: string }; overlay: { $ref: string }; progress: { $ref: string }; reconnect: { $ref: string }; webSocketTransport: { $ref: string }; webSocketURL: { $ref: string } }; type: string })[]; description: string; link: string }; ClientLogging: { description: string; enum: string[]; link: string }; ClientOverlay: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; description: string; link: string; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; description?: undefined; link?: undefined; properties: { errors: { cli: { negatedDescription: string }; description: string; type: string }; trustedTypesPolicyName: { description: string; type: string }; warnings: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[] }; ClientProgress: { cli: { negatedDescription: string }; description: string; link: string; type: string }; ClientReconnect: { anyOf: ({ cli: { negatedDescription: string }; minimum?: undefined; type: string } | { cli?: undefined; minimum: number; type: string })[]; description: string; link: string }; ClientWebSocketTransport: { anyOf: { $ref: string }[]; description: string; link: string }; ClientWebSocketTransportEnum: { enum: string[] }; ClientWebSocketTransportString: { minLength: number; type: string }; ClientWebSocketURL: { anyOf: ({ additionalProperties?: undefined; minLength: number; properties?: undefined; type: string } | { additionalProperties: boolean; minLength?: undefined; properties: { hostname: { description: string; minLength: number; type: string }; password: { description: string; type: string }; pathname: { description: string; type: string }; port: { anyOf: ({ minLength?: undefined; type: string } | { minLength: number; type: string })[]; description: string }; protocol: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string }; username: { description: string; type: string } }; type: string })[]; description: string; link: string }; Compress: { cli: { negatedDescription: string }; description: string; link: string; type: string }; DevMiddleware: { additionalProperties: boolean; description: string; link: string; type: string }; HTTP2: { cli: { negatedDescription: string }; description: string; link: string; type: string }; HTTPS: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[]; description: string; link: string }; HeaderObject: { additionalProperties: boolean; cli: { exclude: boolean }; properties: { key: { description: string; type: string }; value: { description: string; type: string } }; type: string }; Headers: { anyOf: ({ instanceof?: undefined; items: { $ref: string }; minItems: number; type: string } | { instanceof?: undefined; items?: undefined; minItems?: undefined; type: string } | { instanceof: string; items?: undefined; minItems?: undefined; type?: undefined })[]; description: string; link: string }; HistoryApiFallback: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }; Host: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string; link: string }; Hot: { anyOf: ({ cli: { negatedDescription: string }; enum?: undefined; type: string } | { cli?: undefined; enum: string[]; type?: undefined })[]; description: string; link: string }; IPC: { anyOf: ({ enum?: undefined; minLength: number; type: string } | { enum: boolean[]; minLength?: undefined; type: string })[]; description: string; link: string }; LiveReload: { cli: { negatedDescription: string }; description: string; link: string; type: string }; MagicHTML: { cli: { negatedDescription: string }; description: string; link: string; type: string }; OnAfterSetupMiddleware: { description: string; instanceof: string; link: string }; OnBeforeSetupMiddleware: { description: string; instanceof: string; link: string }; OnListening: { description: string; instanceof: string; link: string }; Open: { anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]; description: string; link: string }; OpenBoolean: { cli: { negatedDescription: string }; type: string }; OpenObject: { additionalProperties: boolean; properties: { app: { anyOf: ({ additionalProperties: boolean; cli?: undefined; description?: undefined; minLength?: undefined; properties: { arguments: { items: { minLength: number; type: string } }; name: { anyOf: ({ items: { minLength: number; type: string }; minItems: number; minLength?: undefined; type: string } | { items?: undefined; minItems?: undefined; minLength: number; type: string })[] } }; type: string } | { additionalProperties?: undefined; cli: { description: string }; description: string; minLength: number; properties?: undefined; type: string })[]; description: string }; target: { anyOf: ({ items: { type: string }; type: string } | { items?: undefined; type: string })[]; description: string } }; type: string }; OpenString: { minLength: number; type: string }; Port: { anyOf: ({ enum?: undefined; maximum: number; minLength?: undefined; minimum: number; type: string } | { enum?: undefined; maximum?: undefined; minLength: number; minimum?: undefined; type: string } | { enum: string[]; maximum?: undefined; minLength?: undefined; minimum?: undefined; type?: undefined })[]; description: string; link: string }; Proxy: { anyOf: ({ items?: undefined; type: string } | { items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string })[]; description: string; link: string }; Server: { anyOf: { $ref: string }[]; description: string; link: string }; ServerEnum: { cli: { exclude: boolean }; enum: string[] }; ServerObject: { additionalProperties: boolean; properties: { options: { $ref: string }; type: { anyOf: { $ref: string }[] } }; type: string }; ServerOptions: { additionalProperties: boolean; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string }; ServerString: { cli: { exclude: boolean }; minLength: number; type: string }; ServerType: { enum: string[] }; SetupExitSignals: { cli: { exclude: boolean }; description: string; link: string; type: string }; SetupMiddlewares: { description: string; instanceof: string; link: string }; Static: { anyOf: ({ $ref?: undefined; cli?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref?: undefined; cli: { negatedDescription: string }; items?: undefined; type: string } | { $ref: string; cli?: undefined; items?: undefined; type?: undefined })[]; description: string; link: string }; StaticObject: { additionalProperties: boolean; properties: { directory: { description: string; link: string; minLength: number; type: string }; publicPath: { anyOf: ({ items: { type: string }; minItems: number; type: string } | { items?: undefined; minItems?: undefined; type: string })[]; description: string; link: string }; serveIndex: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; type: string } | { additionalProperties: boolean; cli?: undefined; type: string })[]; description: string; link: string }; staticOptions: { additionalProperties: boolean; link: string; type: string }; watch: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string } }; type: string }; StaticString: { minLength: number; type: string }; WatchFiles: { anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]; description: string; link: string }; WatchFilesObject: { additionalProperties: boolean; cli: { exclude: boolean }; properties: { options: { additionalProperties: boolean; description: string; link: string; type: string }; paths: { anyOf: ({ items: { minLength: number; type: string }; minLength?: undefined; type: string } | { items?: undefined; minLength: number; type: string })[]; description: string } }; type: string }; WatchFilesString: { minLength: number; type: string }; WebSocketServer: { anyOf: { $ref: string }[]; description: string; link: string }; WebSocketServerEnum: { anyOf: ({ $ref?: undefined; cli: { negatedDescription: string }; enum: boolean[] } | { $ref: string; cli?: undefined; enum?: undefined })[]; cli: { description: string } }; WebSocketServerFunction: { instanceof: string }; WebSocketServerObject: { additionalProperties: boolean; properties: { options: { additionalProperties: boolean; cli: { exclude: boolean }; type: string }; type: { anyOf: { $ref: string }[] } }; type: string }; WebSocketServerString: { minLength: number; type: string }; WebSocketServerType: { enum: string[] } }
      • AllowedHosts: { anyOf: ({ $ref?: undefined; enum?: undefined; items: { $ref: string }; minItems: number; type: string } | { $ref?: undefined; enum: string[]; items?: undefined; minItems?: undefined; type?: undefined } | { $ref: string; enum?: undefined; items?: undefined; minItems?: undefined; type?: undefined })[]; description: string; link: string }
        • anyOf: ({ $ref?: undefined; enum?: undefined; items: { $ref: string }; minItems: number; type: string } | { $ref?: undefined; enum: string[]; items?: undefined; minItems?: undefined; type?: undefined } | { $ref: string; enum?: undefined; items?: undefined; minItems?: undefined; type?: undefined })[]
        • description: string
        • link: string
      • AllowedHostsItem: { minLength: number; type: string }
        • minLength: number
        • type: string
      • Bonjour: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }
        • anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]
        • description: string
        • link: string
      • Client: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; enum: boolean[]; properties?: undefined; type?: undefined } | { additionalProperties: boolean; cli?: undefined; enum?: undefined; properties: { logging: { $ref: string }; overlay: { $ref: string }; progress: { $ref: string }; reconnect: { $ref: string }; webSocketTransport: { $ref: string }; webSocketURL: { $ref: string } }; type: string })[]; description: string; link: string }
        • anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; enum: boolean[]; properties?: undefined; type?: undefined } | { additionalProperties: boolean; cli?: undefined; enum?: undefined; properties: { logging: { $ref: string }; overlay: { $ref: string }; progress: { $ref: string }; reconnect: { $ref: string }; webSocketTransport: { $ref: string }; webSocketURL: { $ref: string } }; type: string })[]
        • description: string
        • link: string
      • ClientLogging: { description: string; enum: string[]; link: string }
        • description: string
        • enum: string[]
        • link: string
      • ClientOverlay: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; description: string; link: string; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; description?: undefined; link?: undefined; properties: { errors: { cli: { negatedDescription: string }; description: string; type: string }; trustedTypesPolicyName: { description: string; type: string }; warnings: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[] }
        • anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; description: string; link: string; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; description?: undefined; link?: undefined; properties: { errors: { cli: { negatedDescription: string }; description: string; type: string }; trustedTypesPolicyName: { description: string; type: string }; warnings: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[]
      • ClientProgress: { cli: { negatedDescription: string }; description: string; link: string; type: string }
        • cli: { negatedDescription: string }
          • negatedDescription: string
        • description: string
        • link: string
        • type: string
      • ClientReconnect: { anyOf: ({ cli: { negatedDescription: string }; minimum?: undefined; type: string } | { cli?: undefined; minimum: number; type: string })[]; description: string; link: string }
        • anyOf: ({ cli: { negatedDescription: string }; minimum?: undefined; type: string } | { cli?: undefined; minimum: number; type: string })[]
        • description: string
        • link: string
      • ClientWebSocketTransport: { anyOf: { $ref: string }[]; description: string; link: string }
        • anyOf: { $ref: string }[]
        • description: string
          property

          {boolean | string} [ipc]

          property

          {Host} [host]

          property

          {Port} [port]

          property

          {boolean | "only"} [hot]

          property

          {boolean} [liveReload]

          property

          {DevMiddlewareOptions<Request, Response>} [devMiddleware]

          property

          {boolean} [compress]

          property

          {boolean} [magicHtml]

          property

          {"auto" | "all" | string | string[]} [allowedHosts]

          property

          {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]

          property

          {boolean} [setupExitSignals]

          property

          {boolean | Record<string, never> | BonjourOptions} [bonjour]

          property

          {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]

          property

          {boolean | string | Static | Array<string | Static>} [static]

          property

          {boolean | ServerOptions} [https]

          property

          {boolean} [http2]

          property

          {"http" | "https" | "spdy" | string | ServerConfiguration} [server]

          property

          {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]

          property

          {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]

          property

          {boolean | string | Open | Array<string | Open>} [open]

          property

          {boolean} [setupExitSignals]

          property

          {boolean | ClientConfiguration} [client]

          property

          {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]

          property

          {(devServer: Server) => void} [onAfterSetupMiddleware]

          property

          {(devServer: Server) => void} [onBeforeSetupMiddleware]

          property

          {(devServer: Server) => void} [onListening]

          property

          {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]

        • link: string
      • ClientWebSocketTransportEnum: { enum: string[] }
        • enum: string[]
      • ClientWebSocketTransportString: { minLength: number; type: string }
        • minLength: number
        • type: string
      • ClientWebSocketURL: { anyOf: ({ additionalProperties?: undefined; minLength: number; properties?: undefined; type: string } | { additionalProperties: boolean; minLength?: undefined; properties: { hostname: { description: string; minLength: number; type: string }; password: { description: string; type: string }; pathname: { description: string; type: string }; port: { anyOf: ({ minLength?: undefined; type: string } | { minLength: number; type: string })[]; description: string }; protocol: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string }; username: { description: string; type: string } }; type: string })[]; description: string; link: string }
        • anyOf: ({ additionalProperties?: undefined; minLength: number; properties?: undefined; type: string } | { additionalProperties: boolean; minLength?: undefined; properties: { hostname: { description: string; minLength: number; type: string }; password: { description: string; type: string }; pathname: { description: string; type: string }; port: { anyOf: ({ minLength?: undefined; type: string } | { minLength: number; type: string })[]; description: string }; protocol: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string }; username: { description: string; type: string } }; type: string })[]
        • description: string
        • link: string
      • Compress: { cli: { negatedDescription: string }; description: string; link: string; type: string }
        • cli: { negatedDescription: string }
          • negatedDescription: string
        • description: string
        • link: string
        • type: string
      • DevMiddleware: { additionalProperties: boolean; description: string; link: string; type: string }
        • additionalProperties: boolean
        • description: string
        • link: string
        • type: string
      • HTTP2: { cli: { negatedDescription: string }; description: string; link: string; type: string }
        • cli: { negatedDescription: string }
          • negatedDescription: string
        • description: string
        • link: string
        • type: string
      • HTTPS: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[]; description: string; link: string }
        • anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; properties?: undefined; type: string } | { additionalProperties: boolean; cli?: undefined; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string })[]
        • description: string
        • link: string
      • HeaderObject: { additionalProperties: boolean; cli: { exclude: boolean }; properties: { key: { description: string; type: string }; value: { description: string; type: string } }; type: string }
        • additionalProperties: boolean
        • cli: { exclude: boolean }
          • exclude: boolean
        • properties: { key: { description: string; type: string }; value: { description: string; type: string } }
          • key: { description: string; type: string }
            • description: string
            • type: string
          • value: { description: string; type: string }
            • description: string
            • type: string
        • type: string
      • Headers: { anyOf: ({ instanceof?: undefined; items: { $ref: string }; minItems: number; type: string } | { instanceof?: undefined; items?: undefined; minItems?: undefined; type: string } | { instanceof: string; items?: undefined; minItems?: undefined; type?: undefined })[]; description: string; link: string }
        • anyOf: ({ instanceof?: undefined; items: { $ref: string }; minItems: number; type: string } | { instanceof?: undefined; items?: undefined; minItems?: undefined; type: string } | { instanceof: string; items?: undefined; minItems?: undefined; type?: undefined })[]
        • description: string
        • link: string
      • HistoryApiFallback: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }
        • anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]
        • description: string
        • link: string
      • Host: { anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]; description: string; link: string }
        • anyOf: ({ enum: string[]; minLength?: undefined; type?: undefined } | { enum?: undefined; minLength: number; type: string })[]
        • description: string
        • link: string
      • Hot: { anyOf: ({ cli: { negatedDescription: string }; enum?: undefined; type: string } | { cli?: undefined; enum: string[]; type?: undefined })[]; description: string; link: string }
        • anyOf: ({ cli: { negatedDescription: string }; enum?: undefined; type: string } | { cli?: undefined; enum: string[]; type?: undefined })[]
        • description: string
        • link: string
      • IPC: { anyOf: ({ enum?: undefined; minLength: number; type: string } | { enum: boolean[]; minLength?: undefined; type: string })[]; description: string; link: string }
        • anyOf: ({ enum?: undefined; minLength: number; type: string } | { enum: boolean[]; minLength?: undefined; type: string })[]
        • description: string
        • link: string
      • LiveReload: { cli: { negatedDescription: string }; description: string; link: string; type: string }
        • cli: { negatedDescription: string }
          • negatedDescription: string
        • description: string
        • link: string
        • type: string
      • MagicHTML: { cli: { negatedDescription: string }; description: string; link: string; type: string }
        • cli: { negatedDescription: string }
          • negatedDescription: string
        • description: string
        • link: string
        • type: string
      • OnAfterSetupMiddleware: { description: string; instanceof: string; link: string }
        • description: string
        • instanceof: string
        • link: string
      • OnBeforeSetupMiddleware: { description: string; instanceof: string; link: string }
        • description: string
        • instanceof: string
        • link: string
      • OnListening: { description: string; instanceof: string; link: string }
        • description: string
        • instanceof: string
        • link: string
      • Open: { anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]; description: string; link: string }
        • anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]
        • description: string
        • link: string
      • OpenBoolean: { cli: { negatedDescription: string }; type: string }
        • cli: { negatedDescription: string }
          • negatedDescription: string
        • type: string
      • OpenObject: { additionalProperties: boolean; properties: { app: { anyOf: ({ additionalProperties: boolean; cli?: undefined; description?: undefined; minLength?: undefined; properties: { arguments: { items: { minLength: number; type: string } }; name: { anyOf: ({ items: { minLength: number; type: string }; minItems: number; minLength?: undefined; type: string } | { items?: undefined; minItems?: undefined; minLength: number; type: string })[] } }; type: string } | { additionalProperties?: undefined; cli: { description: string }; description: string; minLength: number; properties?: undefined; type: string })[]; description: string }; target: { anyOf: ({ items: { type: string }; type: string } | { items?: undefined; type: string })[]; description: string } }; type: string }
        • additionalProperties: boolean
        • properties: { app: { anyOf: ({ additionalProperties: boolean; cli?: undefined; description?: undefined; minLength?: undefined; properties: { arguments: { items: { minLength: number; type: string } }; name: { anyOf: ({ items: { minLength: number; type: string }; minItems: number; minLength?: undefined; type: string } | { items?: undefined; minItems?: undefined; minLength: number; type: string })[] } }; type: string } | { additionalProperties?: undefined; cli: { description: string }; description: string; minLength: number; properties?: undefined; type: string })[]; description: string }; target: { anyOf: ({ items: { type: string }; type: string } | { items?: undefined; type: string })[]; description: string } }
          • app: { anyOf: ({ additionalProperties: boolean; cli?: undefined; description?: undefined; minLength?: undefined; properties: { arguments: { items: { minLength: number; type: string } }; name: { anyOf: ({ items: { minLength: number; type: string }; minItems: number; minLength?: undefined; type: string } | { items?: undefined; minItems?: undefined; minLength: number; type: string })[] } }; type: string } | { additionalProperties?: undefined; cli: { description: string }; description: string; minLength: number; properties?: undefined; type: string })[]; description: string }
            • anyOf: ({ additionalProperties: boolean; cli?: undefined; description?: undefined; minLength?: undefined; properties: { arguments: { items: { minLength: number; type: string } }; name: { anyOf: ({ items: { minLength: number; type: string }; minItems: number; minLength?: undefined; type: string } | { items?: undefined; minItems?: undefined; minLength: number; type: string })[] } }; type: string } | { additionalProperties?: undefined; cli: { description: string }; description: string; minLength: number; properties?: undefined; type: string })[]
            • description: string
          • target: { anyOf: ({ items: { type: string }; type: string } | { items?: undefined; type: string })[]; description: string }
            • anyOf: ({ items: { type: string }; type: string } | { items?: undefined; type: string })[]
            • description: string
        • type: string
      • OpenString: { minLength: number; type: string }
        • minLength: number
        • type: string
      • Port: { anyOf: ({ enum?: undefined; maximum: number; minLength?: undefined; minimum: number; type: string } | { enum?: undefined; maximum?: undefined; minLength: number; minimum?: undefined; type: string } | { enum: string[]; maximum?: undefined; minLength?: undefined; minimum?: undefined; type?: undefined })[]; description: string; link: string }
        • anyOf: ({ enum?: undefined; maximum: number; minLength?: undefined; minimum: number; type: string } | { enum?: undefined; maximum?: undefined; minLength: number; minimum?: undefined; type: string } | { enum: string[]; maximum?: undefined; minLength?: undefined; minimum?: undefined; type?: undefined })[]
        • description: string
        • link: string
      • Proxy: { anyOf: ({ items?: undefined; type: string } | { items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string })[]; description: string; link: string }
        • anyOf: ({ items?: undefined; type: string } | { items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string })[]
        • description: string
        • link: string
      • Server: { anyOf: { $ref: string }[]; description: string; link: string }
        • anyOf: { $ref: string }[]
        • description: string
        • link: string
      • ServerEnum: { cli: { exclude: boolean }; enum: string[] }
        • cli: { exclude: boolean }
          • exclude: boolean
        • enum: string[]
      • ServerObject: { additionalProperties: boolean; properties: { options: { $ref: string }; type: { anyOf: { $ref: string }[] } }; type: string }
        • additionalProperties: boolean
        • properties: { options: { $ref: string }; type: { anyOf: { $ref: string }[] } }
          • options: { $ref: string }
            • $ref: string
          • type: { anyOf: { $ref: string }[] }
            • anyOf: { $ref: string }[]
        • type: string
      • ServerOptions: { additionalProperties: boolean; properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }; type: string }
        • additionalProperties: boolean
        • properties: { ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; passphrase: { description: string; type: string }; pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }; requestCert: { cli: { negatedDescription: string }; description: string; type: string } }
          • ca: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }
            • anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]
            • description: string
          • cacert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }
            • anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]
            • description: string
          • cert: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }
            • anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]
            • description: string
          • crl: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }
            • anyOf: ({ instanceof?: undefined; items: { anyOf: ({ instanceof?: undefined; type: string } | { instanceof: string; type?: undefined })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]
            • description: string
          • key: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }
            • anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]
            • description: string
          • passphrase: { description: string; type: string }
            • description: string
            • type: string
          • pfx: { anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]; description: string }
            • anyOf: ({ instanceof?: undefined; items: { anyOf: ({ additionalProperties?: undefined; instanceof?: undefined; type: string } | { additionalProperties?: undefined; instanceof: string; type?: undefined } | { additionalProperties: boolean; instanceof?: undefined; type: string })[] }; type: string } | { instanceof?: undefined; items?: undefined; type: string } | { instanceof: string; items?: undefined; type?: undefined })[]
            • description: string
          • requestCert: { cli: { negatedDescription: string }; description: string; type: string }
            • cli: { negatedDescription: string }
              • negatedDescription: string
            • description: string
            • type: string
        • type: string
      • ServerString: { cli: { exclude: boolean }; minLength: number; type: string }
        • cli: { exclude: boolean }
          • exclude: boolean
        • minLength: number
        • type: string
      • ServerType: { enum: string[] }
        • enum: string[]
      • SetupExitSignals: { cli: { exclude: boolean }; description: string; link: string; type: string }
        • cli: { exclude: boolean }
          • exclude: boolean
        • description: string
        • link: string
        • type: string
      • SetupMiddlewares: { description: string; instanceof: string; link: string }
        • description: string
        • instanceof: string
        • link: string
      • Static: { anyOf: ({ $ref?: undefined; cli?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref?: undefined; cli: { negatedDescription: string }; items?: undefined; type: string } | { $ref: string; cli?: undefined; items?: undefined; type?: undefined })[]; description: string; link: string }
        • anyOf: ({ $ref?: undefined; cli?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref?: undefined; cli: { negatedDescription: string }; items?: undefined; type: string } | { $ref: string; cli?: undefined; items?: undefined; type?: undefined })[]
        • description: string
        • link: string
      • StaticObject: { additionalProperties: boolean; properties: { directory: { description: string; link: string; minLength: number; type: string }; publicPath: { anyOf: ({ items: { type: string }; minItems: number; type: string } | { items?: undefined; minItems?: undefined; type: string })[]; description: string; link: string }; serveIndex: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; type: string } | { additionalProperties: boolean; cli?: undefined; type: string })[]; description: string; link: string }; staticOptions: { additionalProperties: boolean; link: string; type: string }; watch: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string } }; type: string }
        • additionalProperties: boolean
        • properties: { directory: { description: string; link: string; minLength: number; type: string }; publicPath: { anyOf: ({ items: { type: string }; minItems: number; type: string } | { items?: undefined; minItems?: undefined; type: string })[]; description: string; link: string }; serveIndex: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; type: string } | { additionalProperties: boolean; cli?: undefined; type: string })[]; description: string; link: string }; staticOptions: { additionalProperties: boolean; link: string; type: string }; watch: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string } }
          • directory: { description: string; link: string; minLength: number; type: string }
            • description: string
            • link: string
            • minLength: number
            • type: string
          • publicPath: { anyOf: ({ items: { type: string }; minItems: number; type: string } | { items?: undefined; minItems?: undefined; type: string })[]; description: string; link: string }
            • anyOf: ({ items: { type: string }; minItems: number; type: string } | { items?: undefined; minItems?: undefined; type: string })[]
            • description: string
            • link: string
          • serveIndex: { anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; type: string } | { additionalProperties: boolean; cli?: undefined; type: string })[]; description: string; link: string }
            • anyOf: ({ additionalProperties?: undefined; cli: { negatedDescription: string }; type: string } | { additionalProperties: boolean; cli?: undefined; type: string })[]
            • description: string
            • link: string
          • staticOptions: { additionalProperties: boolean; link: string; type: string }
            • additionalProperties: boolean
            • link: string
            • type: string
          • watch: { anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]; description: string; link: string }
            • anyOf: ({ cli: { negatedDescription: string }; description?: undefined; link?: undefined; type: string } | { cli?: undefined; description: string; link: string; type: string })[]
            • description: string
            • link: string
        • type: string
      • StaticString: { minLength: number; type: string }
        • minLength: number
        • type: string
      • WatchFiles: { anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]; description: string; link: string }
        • anyOf: ({ $ref?: undefined; items: { anyOf: { $ref: string }[] }; type: string } | { $ref: string; items?: undefined; type?: undefined })[]
        • description: string
        • link: string
      • WatchFilesObject: { additionalProperties: boolean; cli: { exclude: boolean }; properties: { options: { additionalProperties: boolean; description: string; link: string; type: string }; paths: { anyOf: ({ items: { minLength: number; type: string }; minLength?: undefined; type: string } | { items?: undefined; minLength: number; type: string })[]; description: string } }; type: string }
        • additionalProperties: boolean
        • cli: { exclude: boolean }
          • exclude: boolean
        • properties: { options: { additionalProperties: boolean; description: string; link: string; type: string }; paths: { anyOf: ({ items: { minLength: number; type: string }; minLength?: undefined; type: string } | { items?: undefined; minLength: number; type: string })[]; description: string } }
          • options: { additionalProperties: boolean; description: string; link: string; type: string }
            • additionalProperties: boolean
            • description: string
            • link: string
            • type: string
          • paths: { anyOf: ({ items: { minLength: number; type: string }; minLength?: undefined; type: string } | { items?: undefined; minLength: number; type: string })[]; description: string }
            • anyOf: ({ items: { minLength: number; type: string }; minLength?: undefined; type: string } | { items?: undefined; minLength: number; type: string })[]
            • description: string
        • type: string
      • WatchFilesString: { minLength: number; type: string }
        • minLength: number
        • type: string
      • WebSocketServer: { anyOf: { $ref: string }[]; description: string; link: string }
        • anyOf: { $ref: string }[]
        • description: string
        • link: string
      • WebSocketServerEnum: { anyOf: ({ $ref?: undefined; cli: { negatedDescription: string }; enum: boolean[] } | { $ref: string; cli?: undefined; enum?: undefined })[]; cli: { description: string } }
        • anyOf: ({ $ref?: undefined; cli: { negatedDescription: string }; enum: boolean[] } | { $ref: string; cli?: undefined; enum?: undefined })[]
        • cli: { description: string }
          • description: string
      • WebSocketServerFunction: { instanceof: string }
        • instanceof: string
      • WebSocketServerObject: { additionalProperties: boolean; properties: { options: { additionalProperties: boolean; cli: { exclude: boolean }; type: string }; type: { anyOf: { $ref: string }[] } }; type: string }
        • additionalProperties: boolean
        • properties: { options: { additionalProperties: boolean; cli: { exclude: boolean }; type: string }; type: { anyOf: { $ref: string }[] } }
          • options: { additionalProperties: boolean; cli: { exclude: boolean }; type: string }
            • additionalProperties: boolean
            • cli: { exclude: boolean }
              • exclude: boolean
            • type: string
          • type: { anyOf: { $ref: string }[] }
            • anyOf: { $ref: string }[]
        • type: string
      • WebSocketServerString: { minLength: number; type: string }
        • minLength: number
        • type: string
      • WebSocketServerType: { enum: string[] }
        • enum: string[]
    • properties: { allowedHosts: { $ref: string }; bonjour: { $ref: string }; client: { $ref: string }; compress: { $ref: string }; devMiddleware: { $ref: string }; headers: { $ref: string }; historyApiFallback: { $ref: string }; host: { $ref: string }; hot: { $ref: string }; http2: { $ref: string }; https: { $ref: string }; ipc: { $ref: string }; liveReload: { $ref: string }; magicHtml: { $ref: string }; onAfterSetupMiddleware: { $ref: string }; onBeforeSetupMiddleware: { $ref: string }; onListening: { $ref: string }; open: { $ref: string }; port: { $ref: string }; proxy: { $ref: string }; server: { $ref: string }; setupExitSignals: { $ref: string }; setupMiddlewares: { $ref: string }; static: { $ref: string }; watchFiles: { $ref: string }; webSocketServer: { $ref: string } }
      • allowedHosts: { $ref: string }
        • $ref: string
      • bonjour: { $ref: string }
        • $ref: string
      • client: { $ref: string }
        • $ref: string
      • compress: { $ref: string }
        • $ref: string
      • devMiddleware: { $ref: string }
        • $ref: string
      • headers: { $ref: string }
        • $ref: string
      • historyApiFallback: { $ref: string }
        • $ref: string
      • host: { $ref: string }
        • $ref: string
      • hot: { $ref: string }
        • $ref: string
      • http2: { $ref: string }
        • $ref: string
      • https: { $ref: string }
        • $ref: string
      • ipc: { $ref: string }
        • $ref: string
      • liveReload: { $ref: string }
        • $ref: string
      • magicHtml: { $ref: string }
        • $ref: string
      • onAfterSetupMiddleware: { $ref: string }
        • $ref: string
      • onBeforeSetupMiddleware: { $ref: string }
        • $ref: string
      • onListening: { $ref: string }
        • $ref: string
      • open: { $ref: string }
        • $ref: string
      • port: { $ref: string }
        • $ref: string
      • proxy: { $ref: string }
        • $ref: string
      • server: { $ref: string }
        • $ref: string
      • setupExitSignals: { $ref: string }
        • $ref: string
      • setupMiddlewares: { $ref: string }
        • $ref: string
      • static: { $ref: string }
        • $ref: string
      • watchFiles: { $ref: string }
        • $ref: string
      • webSocketServer: { $ref: string }
        • $ref: string
    • title: string
    • type: string

Methods

  • close(callback?: (err?: Error) => void): void
  • Parameters

    • Optional callback: (err?: Error) => void
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns void

  • listen(port: Port, hostname: string, fn: (err?: Error) => void): void
  • Parameters

    • port: Port
    • hostname: string
    • fn: (err?: Error) => void
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns void

  • sendMessage(clients: ClientConnection[], type: string, data?: any, params?: any): void
  • Parameters

    Returns void

  • start(): Promise<void>
  • Returns Promise<void>

  • startCallback(callback?: (err?: Error) => void): void
  • Parameters

    • Optional callback: (err?: Error) => void
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns void

  • stop(): Promise<void>
  • Returns Promise<void>

  • stopCallback(callback?: (err?: Error) => void): void
  • Parameters

    • Optional callback: (err?: Error) => void
        • (err?: Error): void
        • Parameters

          • Optional err: Error

          Returns void

    Returns void

  • findCacheDir(): string
  • Returns string

  • findIp(gateway: string): undefined | string
  • Parameters

    • gateway: string

    Returns undefined | string

  • getFreePort(port: Port, host: string): Promise<string | number>
  • Parameters

    • port: Port
    • host: string

    Returns Promise<string | number>

  • getHostname(hostname: string): Promise<string>
  • Parameters

    • hostname: string

    Returns Promise<string>

  • internalIP(family: "v4" | "v6"): Promise<undefined | string>
  • Parameters

    • family: "v4" | "v6"

    Returns Promise<undefined | string>

  • internalIPSync(family: "v4" | "v6"): undefined | string
  • Parameters

    • family: "v4" | "v6"

    Returns undefined | string

  • isAbsoluteURL(URL: string): boolean
  • Parameters

    • URL: string

    Returns boolean