polyserve

property kind

kind: 'control';

property kind

kind: 'mainline';

property app

app: express.Application;

property kind

kind: 'control' | 'mainline' | 'variant';

property options

options: ServerOptions;

property server

server: http.Server;

property additionalRoutes

additionalRoutes?: Map<string, express.RequestHandler>;

• An optional list of routes & route handlers to attach to the polyserve app, to be handled before all others

property allowOrigin

allowOrigin?: string;

• Sets the value of the Access-Control-Allow-Origin header

property browser

browser?: string[];

• The browser(s) to open when run with open argument *

property certPath

certPath?: string;

• Path to TLS certificate for HTTPS

property compile

compile?: 'always' | 'never' | 'auto';

• Whether or not to compile JavaScript *

property componentDir

componentDir?: string;

• The component directory to use *

property componentUrl

componentUrl?: string;

• The component url to serve *

property entrypoint

entrypoint?: string;

• The path on disk of the entry point HTML file that will be served for app-shell style projects. Must be contained by root. Defaults to index.html.

property headers

headers?: {
    [name: string]: string;
};

• Headers to send with every response

property hostname

hostname?: string;

• The hostname to serve from

property keyPath

keyPath?: string;

• Path to TLS service key for HTTPS

property moduleResolution

moduleResolution?: 'none' | 'node';

• Resolution algorithm to use for rewriting module specifiers

property npm

npm?: boolean;

• Sets npm mode: component directory is 'node_modules' and the package name is read from package.json.

property open

open?: boolean;

• Whether to open the browser when run *

property openPath

openPath?: string;

• The URL path to open in each browser *

property packageName

packageName?: string;

• The package name to use for the root directory *

property port

port?: number;

• The port to serve from

property protocol

protocol?: string;

• The HTTP protocol to use

property proxy

proxy?: {
    path: string;
    target: string;
};

• Proxy to redirect for all matching path to target

property pushManifestPath

pushManifestPath?: string;

• Path to H2 push-manifest file

property root

root?: string;

• The root directory to serve *

property dependencyDir

dependencyDir: string;

property kind

kind: 'variant';

property variantName

variantName: string;

function commandLineArgs

commandLineArgs: (
    descriptors: commandLineArgs.ArgDescriptor[],
    args?: string[]
) => any;

• Parameter descriptors

  An array of objects that describe the arguments that we want to parse.

  Parameter args

  Optional arguments to parse. If not given, process.argv is used.

function commandLineUsage

commandLineUsage: (args: commandLineUsage.Section[]) => any;

function findPort

findPort: (
    lower: number,
    upper: number,
    callback: (ports: number[]) => void
) => void;

function intercept

intercept: (onIntercept: (txt: string) => void) => () => void;

variable send

var send: Send;