types: add typings for realm function (fix #40) (#105)

fastify · Sep 2, 2022 · b66d5d4 · b66d5d4
1 parent d0d5219
commit b66d5d4
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -26,7 +26,7 @@ export interface FastifyBasicAuthOptions {
     reply: FastifyReply,
     done: (err?: Error) => void
   ): void | Promise<void|Error>;
-  authenticate?: boolean | { realm: string };
+  authenticate?: boolean | { realm: string | ((req: FastifyRequest) => string) };
   header?: string;
 }
 

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -49,6 +49,26 @@ app.register(fastifyBasicAuth, {
   }
 })
 
+//authenticate boolean
+app.register(fastifyBasicAuth, {
+  validate: () => {},
+  authenticate: true
+})
+
+//authenticate with realm
+app.register(fastifyBasicAuth, {
+  validate: () => {},
+  authenticate: { realm: 'example' }
+})
+
+//authenticate with realm (function)
+app.register(fastifyBasicAuth, {
+  validate: () => {},
+  authenticate: { realm: function realm(req) {
+    return req.routerPath
+  }}
+})
+
 expectAssignable<onRequestHookHandler>(app.basicAuth)
 expectAssignable<preValidationHookHandler>(app.basicAuth)
 expectAssignable<preHandlerHookHandler>(app.basicAuth)