Export the configuration interface (#18162)

Added class for the server instead of interface
Added TS lint file and fixed errors
This commit is contained in:
Dave Parslow
2017-07-24 09:20:10 -07:00
committed by Andy
parent 84384b0417
commit 6333711213
3 changed files with 61 additions and 56 deletions

View File

@@ -1,54 +1,54 @@
// Type definitions for webpack-dev-server 2.4.5
// Type definitions for webpack-dev-server 2.4
// Project: https://github.com/webpack/webpack-dev-server
// Definitions by: maestroh <https://github.com/maestroh>
// Dave Parslow <https://github.com/daveparslow>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare module "webpack-dev-server" {
import * as webpack from 'webpack';
import * as core from 'express-serve-static-core';
import * as serveStatic from 'serve-static';
import * as http from 'http';
import * as webpack from 'webpack';
import * as core from 'express-serve-static-core';
import * as serveStatic from 'serve-static';
import * as http from 'http';
namespace WebpackDevServer {
export interface Configuration {
contentBase?: string;
hot?: boolean;
https?: boolean;
historyApiFallback?: boolean;
compress?: boolean;
proxy?: any;
staticOptions?: any;
quiet?: boolean;
noInfo?: boolean;
lazy?: boolean;
filename?: string| RegExp;
watchOptions?: webpack.WatchOptions;
publicPath: string;
headers?: any;
stats?: webpack.compiler.StatsOptions| webpack.compiler.StatsToStringOptions;
public?: string;
disableHostCheck?: boolean;
declare namespace WebpackDevServer {
interface Configuration {
contentBase?: string;
hot?: boolean;
https?: boolean;
historyApiFallback?: boolean;
compress?: boolean;
proxy?: any;
staticOptions?: any;
quiet?: boolean;
noInfo?: boolean;
lazy?: boolean;
filename?: string| RegExp;
watchOptions?: webpack.WatchOptions;
publicPath: string;
headers?: any;
stats?: webpack.compiler.StatsOptions| webpack.compiler.StatsToStringOptions;
public?: string;
disableHostCheck?: boolean;
setup?(app: core.Express): void;
}
export interface WebpackDevServer {
new (
webpack: webpack.compiler.Compiler,
config: Configuration
):WebpackDevServer;
listen(port: number,
hostname: string,
callback?: Function
): http.Server;
listen(port: number,
callback?: Function
): http.Server;
}
setup?(app: core.Express): void;
}
var wds: WebpackDevServer.WebpackDevServer;
}
export = wds;
}
declare class WebpackDevServer {
constructor(
webpack: webpack.compiler.Compiler,
config: WebpackDevServer.Configuration
);
listen(
port: number,
hostname: string,
callback?: (...args: any[]) => any
): http.Server;
listen(
port: number,
callback?: (...args: any[]) => any
): http.Server;
}
export = WebpackDevServer;

View File

@@ -0,0 +1 @@
{ "extends": "dtslint/dt.json" }

View File

@@ -1,15 +1,16 @@
import * as webpack from 'webpack';
import * as WebpackDevServer from 'webpack-dev-server';
var compiler = webpack({});
import * as core from 'express-serve-static-core';
let compiler = webpack({});
// basic example
var server = new WebpackDevServer(compiler, {
let server = new WebpackDevServer(compiler, {
publicPath: "/assets/"
});
server.listen(8080);
// API example
server = new WebpackDevServer(compiler, {
// Configuration can be used as a type
let config: WebpackDevServer.Configuration = {
// webpack-dev-server options
contentBase: "/path/to/directory",
// or: contentBase: "http://localhost/",
@@ -41,12 +42,12 @@ server = new WebpackDevServer(compiler, {
"**": "http://localhost:9090"
},
setup: function (app) {
setup: (app: core.Express) => {
// Here you can access the Express app object and add your own custom middleware to it.
// For example, to define custom handlers for some paths:
// app.get('/some/path', function(req, res) {
// res.json({ custom: 'response' });
// });
app.get('/some/path', (req, res) => {
res.json({ custom: 'response' });
});
},
// pass [static options](http://expressjs.com/en/4x/api.html#express.static) to inner express server
@@ -66,5 +67,8 @@ server = new WebpackDevServer(compiler, {
publicPath: "/assets/",
headers: { "X-Custom-Header": "yes" },
stats: { colors: true }
});
server.listen(8080, "localhost", function () { });
};
// API example
server = new WebpackDevServer(compiler, config);
server.listen(8080, "localhost", () => {});