UNPKG

1.15 kBTypeScriptView Raw
1import { DevServer } from '@web/dev-server-core';
2import { DevServerConfig } from './config/DevServerConfig.js';
3export interface StartDevServerParams {
4 /**
5 * Optional config to merge with the user-defined config.
6 */
7 config?: Partial<DevServerConfig>;
8 /**
9 * Whether to read CLI args. Default true.
10 */
11 readCliArgs?: boolean;
12 /**
13 * Whether to read a user config from the file system. Default true.
14 */
15 readFileConfig?: boolean;
16 /**
17 * Name of the configuration to read. Defaults to web-dev-server.config.{mjs,cjs,js}
18 */
19 configName?: string;
20 /**
21 * Whether to automatically exit the process when the server is stopped, killed or an error is thrown.
22 */
23 autoExitProcess?: boolean;
24 /**
25 * Whether to log a message when the server is started.
26 */
27 logStartMessage?: boolean;
28 /**
29 * Array to read the CLI args from. Defaults to process.argv.
30 */
31 argv?: string[];
32}
33/**
34 * Starts the dev server.
35 */
36export declare function startDevServer(options?: StartDevServerParams): Promise<DevServer>;
37//# sourceMappingURL=startDevServer.d.ts.map
\No newline at end of file