fix: add type checking tests

fastify · Dec 27, 2023 · a06ad26 · a06ad26
1 parent 19ec132
commit a06ad26
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/fastify.js b/fastify.js
@@ -285,7 +285,7 @@ function fastify (options) {
     hasRoute: function _route (options) {
       return router.hasRoute.call(this, { options })
     },
-    findRoute: function _route (options) {
+    findRoute: function _findRoute (options) {
       return router.findRoute(options)
     },
     // expose logger instance

diff --git a/test/types/route.test-d.ts b/test/types/route.test-d.ts
@@ -3,7 +3,9 @@ import * as http from 'http'
 import { expectAssignable, expectError, expectType } from 'tsd'
 import fastify, { FastifyInstance, FastifyReply, FastifyRequest, RouteHandlerMethod } from '../../fastify'
 import { RequestPayload } from '../../types/hooks'
-import { HTTPMethods } from '../../types/utils'
+import { HTTPMethods, RawServerBase, RawServerDefault } from '../../types/utils'
+import { FindResult, HTTPVersion } from 'find-my-way'
+import { FindMyWayFindResult, FindMyWayVersion } from '../../types/instance'
 
 /*
  * Testing Fastify HTTP Routes and Route Shorthands.
@@ -453,6 +455,13 @@ expectType<boolean>(fastify().hasRoute({
   }
 }))
 
+expectType<FindMyWayFindResult<RawServerDefault>>(
+  fastify().findRoute({
+    url: '/',
+    method: 'get'
+  })
+)
+
 expectType<FastifyInstance>(fastify().route({
   url: '/',
   method: 'get',

diff --git a/types/instance.d.ts b/types/instance.d.ts
@@ -86,6 +86,7 @@ export interface FastifyListenOptions {
 
 type NotInInterface<Key, _Interface> = Key extends keyof _Interface ? never : Key
 type FindMyWayVersion<RawServer extends RawServerBase> = RawServer extends http.Server ? HTTPVersion.V1 : HTTPVersion.V2
+type FindMyWayFindResult<RawServer extends RawServerBase> = FindResult<FindMyWayVersion<RawServer>>
 
 type GetterSetter<This, T> = T | {
   getter: (this: This) => T,
@@ -223,7 +224,7 @@ export interface FastifyInstance<
     RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
     ContextConfig = ContextConfigDefault,
     SchemaCompiler extends FastifySchema = FastifySchema,
-  >(opts: Pick<RouteOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider>, 'method' | 'url' | 'constraints'>): FindResult<FindMyWayVersion<RawServer>>;
+  >(opts: Pick<RouteOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler, TypeProvider>, 'method' | 'url' | 'constraints'>): FindMyWayFindResult<RawServer>;
 
   // addHook: overloads