UNPKG

polyserve

Version:
38 lines (37 loc) 1.42 kB
/** * @license * Copyright (c) 2015 The Polymer Project Authors. All rights reserved. * This code may only be used under the BSD style license found at * http://polymer.github.io/LICENSE.txt * The complete set of authors may be found at * http://polymer.github.io/AUTHORS.txt * The complete set of contributors may be found at * http://polymer.github.io/CONTRIBUTORS.txt * Code distributed by Google as part of the polymer project is also * subject to an additional IP rights grant found at * http://polymer.github.io/PATENTS.txt */ import * as express from 'express'; export interface AppOptions { componentDir: string; packageName: string; headers?: { [name: string]: string; }; root?: string; compile?: 'always' | 'never' | 'auto'; } export interface PolyserveApplication extends express.Express { packageName: string; } /** * Make a polyserve express app. * @param {Object} options * @param {string} options.componentDir The directory to serve components from. * @param {string} options.packageName A name for this polyserve package. * @param {Object} options.headers An object keyed by header name containing * header values. * @param {string} options.root The root directory to serve a package from * @return {Object} An express app which can be served with `app.get` */ export declare function makeApp(options: AppOptions): PolyserveApplication;