UNPKG

1.42 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright (c) 2015 The Polymer Project Authors. All rights reserved.
4 * This code may only be used under the BSD style license found at
5 * http://polymer.github.io/LICENSE.txt
6 * The complete set of authors may be found at
7 * http://polymer.github.io/AUTHORS.txt
8 * The complete set of contributors may be found at
9 * http://polymer.github.io/CONTRIBUTORS.txt
10 * Code distributed by Google as part of the polymer project is also
11 * subject to an additional IP rights grant found at
12 * http://polymer.github.io/PATENTS.txt
13 */
14import * as express from 'express';
15export interface AppOptions {
16 componentDir: string;
17 packageName: string;
18 headers?: {
19 [name: string]: string;
20 };
21 root?: string;
22 compile?: 'always' | 'never' | 'auto';
23}
24export interface PolyserveApplication extends express.Express {
25 packageName: string;
26}
27/**
28 * Make a polyserve express app.
29 * @param {Object} options
30 * @param {string} options.componentDir The directory to serve components from.
31 * @param {string} options.packageName A name for this polyserve package.
32 * @param {Object} options.headers An object keyed by header name containing
33 * header values.
34 * @param {string} options.root The root directory to serve a package from
35 * @return {Object} An express app which can be served with `app.get`
36 */
37export declare function makeApp(options: AppOptions): PolyserveApplication;