diff --git a/types/express-promise-router/express-promise-router-tests.ts b/types/express-promise-router/express-promise-router-tests.ts new file mode 100644 index 0000000000..42e0cdf570 --- /dev/null +++ b/types/express-promise-router/express-promise-router-tests.ts @@ -0,0 +1,12 @@ +import Router = require("express-promise-router"); + +const router = Router(); + +router.get("/", (req, res) => { + // equivalent to calling next() + return Promise.resolve('next'); +}); + +router.post("/", async (req, res) => { + // ... +}); diff --git a/types/express-promise-router/index.d.ts b/types/express-promise-router/index.d.ts new file mode 100644 index 0000000000..507f6d0e40 --- /dev/null +++ b/types/express-promise-router/index.d.ts @@ -0,0 +1,32 @@ +// Type definitions for express-promise-router 2.0 +// Project: https://github.com/express-promise-router/express-promise-router +// Definitions by: Anjun Wang +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +/* =================== USAGE =================== +import Router = require('express-promise-router'); + +const router = Router(); + +router.get('/', (req, res) => { + // equivalent to calling next() + return Promise.resolve('next'); +}) + +router.post('/', async (req, res) => { + // ... +}) + +export default router; + =============================================== */ + +import { Router } from "express"; + +/** + * A simple wrapper for Express 4's Router that allows middleware to return + * promises. If the promise is rejected, `express-promise-router` will call next + * with the reason + */ +declare const PromiseRouter: typeof Router; +export = PromiseRouter; diff --git a/types/express-promise-router/tsconfig.json b/types/express-promise-router/tsconfig.json new file mode 100644 index 0000000000..1f33dd7104 --- /dev/null +++ b/types/express-promise-router/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "express-promise-router-tests.ts" + ] +} diff --git a/types/express-promise-router/tslint.json b/types/express-promise-router/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/express-promise-router/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }