diff --git a/swaggerize-express/swaggerize-express.d.ts b/swaggerize-express/swaggerize-express.d.ts new file mode 100644 index 000000000..ee7f5ca88 --- /dev/null +++ b/swaggerize-express/swaggerize-express.d.ts @@ -0,0 +1,45 @@ +// Type definitions for swaggerize-express 4.x +// Project: https://github.com/krakenjs/swaggerize-express +// Definitions by: TANAKA Koichi + +/* =================== USAGE =================== + + import express = require('express'); + import swaggerize = require('swaggerize-express'); + var app = express(); + app.use(swaggerize({ + api: require('./api.json'), + docspath: '/api-docs', + handlers: './handlers' + }); + + =============================================== */ + +declare module "swaggerize-express" { + import express = require('express'); + function swaggerize(options: swaggerize.Options): express.RequestHandler; + + module swaggerize { + export interface ISwaggerApiDefinition { + swagger: string + host: string + } + + export interface Options { + api: ISwaggerApiDefinition + docspath: String + handlers: String + } + + export interface IConfig { + api: ISwaggerApiDefinition + routes: express.IRoute[] + } + + export interface SwaggerizedExpress extends express.Express { + swagger: IConfig + } + } + + export = swaggerize; +}