frontity
Version:
Frontity cli and entry point to other packages
58 lines (57 loc) • 1.3 kB
TypeScript
/**
* Options for the {@link devCommand} function.
*/
interface DevOptions {
/**
* Builds the project for production.
*
* @defaultValue `false`
*/
production?: boolean;
/**
* Runs the server on a custom port.
*
* @defaultValue `3000`
*/
port?: number;
/**
* Runs the server using https.
*
* @defaultValue `false`
*/
https?: boolean;
/**
* Create bundles with "es5" or "module".
*
* @defaultValue `"module"`
*/
target?: "es5" | "module";
/**
* Don't open a browser window with the localhost.
*
* @defaultValue `false`
*/
dontOpenBrowser?: boolean;
/**
* Set the public path for static assets.
*
* @defaultValue `"/static/"`
*/
publicPath?: string;
/**
* Create HTML files for bundle analyzing.
*
* @defaultValue `false`
*/
analyze?: boolean;
}
/**
* Start a server in development mode.
*
* This function is executed by the CLI when running the `npx frontity dev`
* command.
*
* @param options - Object of type {@link DevOptions}.
*/
declare const devCommand: ({ production, port, https, target, dontOpenBrowser, publicPath, analyze, }: DevOptions) => Promise<void>;
export default devCommand;