fix: typings of fastify.cache.get

fastify · Dec 7, 2023 · 4281478 · 4281478
1 parent 3733c8c
commit 4281478
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -40,10 +40,13 @@ declare namespace fastifyCaching {
    * @link [`abstract-cache` protocol documentation](https://github.com/jsumners/abstract-cache#protocol)
    */
   export interface AbstractCacheCompliantObject {
-    get(
+    get<T = unknown>(
       key: string | { id: string; segment: string },
-      callback?: (error: unknown, result: unknown) => void
+      callback: (error: unknown, result: (T | undefined)) => void
     ): void;
+    get<T = unknown>(
+      key: string | { id: string; segment: string },
+    ): (T | undefined);
     set(
       key: string | { id: string; segment: string },
       value: unknown,

diff --git a/types/index.test-d.ts b/types/index.test-d.ts
@@ -50,3 +50,20 @@ const badCachingOptions = {
 };
 
 expectError(shouldErrorApp.register(fastifyCaching, badCachingOptions));
+
+fastify.get('/three', async (request, reply) => {
+  expectType<unknown>(
+    fastify.cache.get('well-known')
+  );
+  expectType<string|undefined>(
+    fastify.cache.get<string>('well-known')
+  );
+  expectType<void>(
+    fastify.cache.get<string>('well-known', (err, value) => {
+      expectType<unknown>(err);
+      expectType<string|undefined>(value);
+    })
+  );
+
+  return { message: 'two' };
+});