Installation
npm install --save @types/swagger-express-mw
Summary
This package contains type definitions for swagger-express-mw (https://github.com/apigee-127/swagger-express#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/swagger-express-mw.
index.d.ts
/* =================== USAGE ===================
import * as SwaggerExpress from "swagger-express-mw";
import * as express from "express";
let app = express();
let config: SwaggerExpress.Config = {
appRoot: __dirname
};
SwaggerExpress.create(config, (err, middleware) => {
if (err) {
throw err; // or handle error
}
middleware.register(app);
const port = process.env.PORT || 10010;
app.listen(port);
});
=============================================== */
import { Config, ConnectMiddleware } from "swagger-node-runner";
/** export interfaces */
export { Config, ConnectMiddleware } from "swagger-node-runner";
/**
* Create a new instance of a Connect specific `SwaggerNodeRunner` middleware
*
* The `swagger-node-runner` module has the following config priority:
* 1. `swagger_*` environment vars
* 2. `config` passed to `create()`
* 3. read from swagger node in `default.yaml` in config directory
* 4. module defaults
*
* @see @link{https://github.com/apigee-127/swagger-express|Github}
*/
export function create(config: Config, cb: (err: Error | undefined, runner: ConnectMiddleware) => void): void;
Additional Details
- Last updated: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: @types/swagger-node-runner
Credits
These definitions were written by Michael Mrowetz.