Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TypeScript typings #47

Merged
merged 8 commits into from
Jan 19, 2018
Merged

TypeScript typings #47

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
219d000
add dts for better auto complete
bangbang93 Nov 21, 2017
8e4b68d
fix TS2440
bangbang93 Jan 17, 2018
2318b6a
export default
bangbang93 Jan 17, 2018
f29d302
rename function
bangbang93 Jan 17, 2018
95007f1
Add typing tests for TypeScript
mormahr Jan 19, 2018
30e2f79
Set test timeout higher
mormahr Jan 19, 2018
e2c5d7f
Fix code style
mormahr Jan 19, 2018
0f8770b
Update yarn package lock
mormahr Jan 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
declare module 'express-promise-router' {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are importing Router to the scope, and then redefining a Router function, which at least on my version of typescript leads to a conflict

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using 2.5.3,and works fine.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to upgrade to 2.6.2, and the problem still maintains itself:
node_modules/express-promise-router/index.d.ts(2,13): error TS2440: Import declaration conflicts with local declaration of 'Router'..

Still, the fix is pretty simple:

import {Router as RouterExpress, RouterOptions} from 'express'

     function Router(options?: RouterOptions): RouterExpress
 
     export = Router
 }

What do you think?

import {Router, RouterOptions} from 'express'

function Router(options?: RouterOptions): Router

export = Router
}
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"methods": "^1.0.0"
},
"peerDependencies": {
"@types/express": "^4.0.0",
"express": "4.x"
},
"devDependencies": {
Expand All @@ -51,6 +52,7 @@
"shared-git-hooks": "^1.2.1",
"sinon": "^4.0.0"
},
"types": "index.d.ts",
"scripts": {
"format": "prettier --write --trailing-comma es5 --print-width 120 --single-quote --tab-width 4 'lib/*.js' 'test/*.js'",
"lint": "eslint {lib,test}/**/*.js",
Expand Down