Skip to content

Commit

Permalink
Refactored typescript test to use tsd (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
delvedor authored Aug 14, 2020
1 parent 61f897b commit 76954ca
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 150 deletions.
19 changes: 11 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
"version": "3.0.1",
"description": "Crazy fast http radix based router",
"main": "index.js",
"typings": "index.d.ts",
"types": "index.d.ts",
"scripts": {
"bench": "node bench.js",
"test:lint": "standard",
"test:typescript": "tsc --project ./test/types/tsconfig.json",
"test:typescript": "tsd",
"test": "standard && tap -J test/*.test.js && npm run test:typescript",
"test:report": "tap -J test/*.test.js --cov --coverage-report=html --coverage-report=cobertura | tee out.tap",
"test:reporter": "tap-mocha-reporter xunit < out.tap > test/junit-testresults.xml"
Expand All @@ -33,18 +33,21 @@
},
"homepage": "https://github.com/delvedor/find-my-way#readme",
"devDependencies": {
"@types/node": "^11.9.4",
"@types/node": "^14.0.27",
"benchmark": "^2.1.4",
"pre-commit": "^1.2.2",
"request": "^2.88.0",
"standard": "^14.0.0",
"tap": "^14.0.0",
"request": "^2.88.2",
"standard": "^14.3.4",
"tap": "^14.10.8",
"tap-mocha-reporter": "^5.0.1",
"typescript": "^3.3.3"
"tsd": "^0.13.1"
},
"dependencies": {
"fast-decode-uri-component": "^1.0.0",
"fast-decode-uri-component": "^1.0.1",
"safe-regex2": "^2.0.0",
"semver-store": "^0.3.0"
},
"tsd": {
"directory": "test/types"
}
}
126 changes: 0 additions & 126 deletions test/types/index.ts

This file was deleted.

102 changes: 102 additions & 0 deletions test/types/router.test-d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
import { expectType } from 'tsd'
import * as Router from '../../'
import { Http2ServerRequest, Http2ServerResponse } from 'http2'
import { IncomingMessage, ServerResponse } from 'http'

let http1Req!: IncomingMessage;
let http1Res!: ServerResponse;
let http2Req!: Http2ServerRequest;
let http2Res!: Http2ServerResponse;

// HTTP1
{
let handler: Router.Handler<Router.HTTPVersion.V1>
const router = Router({
ignoreTrailingSlash: true,
allowUnsafeRegex: false,
caseSensitive: false,
maxParamLength: 42,
defaultRoute (http1Req, http1Res) {},
onBadUrl (path, http1Req, http1Res) {},
versioning: {
storage () {
return {
get (version) { return handler },
set (version, handler) {},
del (version) {},
empty () {}
}
},
deriveVersion(req) { return '1.0.0' }
}
})
expectType<Router.Instance<Router.HTTPVersion.V1>>(router)

expectType<void>(router.on('GET', '/', () => {}))
expectType<void>(router.on(['GET', 'POST'], '/', () => {}))
expectType<void>(router.on('GET', '/', { version: '1.0.0' }, () => {}))
expectType<void>(router.on('GET', '/', () => {}, {}))
expectType<void>(router.on('GET', '/', { version: '1.0.0' }, () => {}, {}))

expectType<void>(router.get('/', () => {}))
expectType<void>(router.get('/', { version: '1.0.0' }, () => {}))
expectType<void>(router.get('/', () => {}, {}))
expectType<void>(router.get('/', { version: '1.0.0' }, () => {}, {}))

expectType<void>(router.off('GET', '/'))
expectType<void>(router.off(['GET', 'POST'], '/'))

expectType<void>(router.lookup(http1Req, http1Res))
expectType<Router.FindResult<Router.HTTPVersion.V1> | null>(router.find('GET', '/'))
expectType<Router.FindResult<Router.HTTPVersion.V1> | null>(router.find('GET', '/', '1.0.0'))

expectType<void>(router.reset())
expectType<string>(router.prettyPrint())
}

// HTTP2
{
let handler: Router.Handler<Router.HTTPVersion.V2>
const router = Router<Router.HTTPVersion.V2>({
ignoreTrailingSlash: true,
allowUnsafeRegex: false,
caseSensitive: false,
maxParamLength: 42,
defaultRoute (http1Req, http1Res) {},
onBadUrl (path, http1Req, http1Res) {},
versioning: {
storage () {
return {
get (version) { return handler },
set (version, handler) {},
del (version) {},
empty () {}
}
},
deriveVersion(req) { return '1.0.0' }
}
})
expectType<Router.Instance<Router.HTTPVersion.V2>>(router)

expectType<void>(router.on('GET', '/', () => {}))
expectType<void>(router.on(['GET', 'POST'], '/', () => {}))
expectType<void>(router.on('GET', '/', { version: '1.0.0' }, () => {}))
expectType<void>(router.on('GET', '/', () => {}, {}))
expectType<void>(router.on('GET', '/', { version: '1.0.0' }, () => {}, {}))

expectType<void>(router.get('/', () => {}))
expectType<void>(router.get('/', { version: '1.0.0' }, () => {}))
expectType<void>(router.get('/', () => {}, {}))
expectType<void>(router.get('/', { version: '1.0.0' }, () => {}, {}))

expectType<void>(router.off('GET', '/'))
expectType<void>(router.off(['GET', 'POST'], '/'))

expectType<void>(router.lookup(http2Req, http2Res))
expectType<Router.FindResult<Router.HTTPVersion.V2> | null>(router.find('GET', '/'))
expectType<Router.FindResult<Router.HTTPVersion.V2> | null>(router.find('GET', '/', '1.0.0'))

expectType<void>(router.reset())
expectType<string>(router.prettyPrint())

}
16 changes: 0 additions & 16 deletions test/types/tsconfig.json

This file was deleted.

0 comments on commit 76954ca

Please sign in to comment.