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.

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

fix: missing the param done of lookup method #389

Merged
merged 3 commits into from
Mar 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ declare namespace Router {
searchParams: { [k: string]: string }
) => any;

type Done = (err: Error | null, result: any) => void;

interface ConstraintStrategy<V extends HTTPVersion, T = string> {
name: string,
mustMatchWhenDerived?: boolean,
Expand Down Expand Up @@ -160,7 +162,8 @@ declare namespace Router {
lookup<Context>(
req: Req<V>,
res: Res<V>,
ctx?: Context
ctx?: Context | Done,
done?: Done
): any;

find(
Expand Down
12 changes: 9 additions & 3 deletions test/types/router.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ let http1Req!: IncomingMessage;
let http1Res!: ServerResponse;
let http2Req!: Http2ServerRequest;
let http2Res!: Http2ServerResponse;
let ctx!: { req: IncomingMessage; res: ServerResponse };
let done!: (err: Error | null, result: any) => void;

// HTTP1
{
let handler: Router.Handler<Router.HTTPVersion.V1>
let handler!: Router.Handler<Router.HTTPVersion.V1>
const router = Router({
ignoreTrailingSlash: true,
ignoreDuplicateSlashes: true,
Expand Down Expand Up @@ -52,6 +54,8 @@ let http2Res!: Http2ServerResponse;
expectType<void>(router.off(['GET', 'POST'], '/'))

expectType<any>(router.lookup(http1Req, http1Res))
expectType<any>(router.lookup(http1Req, http1Res, done));
expectType<any>(router.lookup(http1Req, http1Res, ctx, done));
expectType<Router.FindResult<Router.HTTPVersion.V1> | null>(router.find('GET', '/'))
expectType<Router.FindResult<Router.HTTPVersion.V1> | null>(router.find('GET', '/', {}))
expectType<Router.FindResult<Router.HTTPVersion.V1> | null>(router.find('GET', '/', {version: '1.0.0'}))
Expand Down Expand Up @@ -86,7 +90,7 @@ let http2Res!: Http2ServerResponse;
}
}

let handler: Router.Handler<Router.HTTPVersion.V2>
let handler!: Router.Handler<Router.HTTPVersion.V2>
const router = Router<Router.HTTPVersion.V2>({
ignoreTrailingSlash: true,
ignoreDuplicateSlashes: true,
Expand Down Expand Up @@ -117,6 +121,8 @@ let http2Res!: Http2ServerResponse;
expectType<void>(router.off(['GET', 'POST'], '/'))

expectType<any>(router.lookup(http2Req, http2Res))
expectType<any>(router.lookup(http2Req, http2Res, done));
expectType<any>(router.lookup(http2Req, http2Res, ctx, done));
expectType<Router.FindResult<Router.HTTPVersion.V2> | null>(router.find('GET', '/', {}))
expectType<Router.FindResult<Router.HTTPVersion.V2> | null>(router.find('GET', '/', {version: '1.0.0', host: 'fastify.io'}))

Expand All @@ -127,7 +133,7 @@ let http2Res!: Http2ServerResponse;

// Custom Constraint
{
let handler: Router.Handler<Router.HTTPVersion.V1>
let handler!: Router.Handler<Router.HTTPVersion.V1>

interface AcceptAndContentType { accept?: string, contentType?: string }

Expand Down
Loading