Skip to content

Fix validate() return type #58

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.

Sign up for GitHub

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+19 −8
Open

Fix validate() return type #58

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0da69d7
Fix validate() return type
flying-sheep Sep 15, 2021
00ea33a
Fix type
flying-sheep Sep 16, 2021
ec8622d
Ensure correct return type
flying-sheep Sep 16, 2021
c733a1f
tighter interface
flying-sheep Sep 16, 2021
4c0c79d
Merge branch 'master' into patch-1
flying-sheep Apr 21, 2022
fcae131
Merge branch 'master' into patch-1
Uzlopak Sep 2, 2022
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
23 changes: 16 additions & 7 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,22 @@ declare module 'fastify' {
}

export interface FastifyBasicAuthOptions {
validate(
username: string,
password: string,
req: FastifyRequest,
reply: FastifyReply,
done: (err?: Error) => void
): void | Promise<void>;
validate: (
(
username: string,
password: string,
req: FastifyRequest,
reply: FastifyReply,
) => Promise<Error | void>
) | (
(
username: string,
password: string,
req: FastifyRequest,
reply: FastifyReply,
done: (err?: Error) => void
) => void
);
authenticate?: boolean | { realm: string };
header?: string;
}
Expand Down
1 change: 1 addition & 0 deletions index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ app.register(fastifyBasicAuth, {
expectType<string>(password)
expectType<FastifyRequest>(req)
expectType<FastifyReply>(reply)
if (Math.random() > 0.5) return new Error()
Copy link
Member

@mcollina mcollina Sep 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this throw instead?

Copy link
Member

@climba03003 climba03003 Sep 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document is using return and it is actually allowed by this line.

fastify-basic-auth/index.js

Line 24 in fdfe2fb

result.then(done, done)

Copy link
Member

@RafaelGSS RafaelGSS Apr 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer two asserts group instead:

  • One returning Promise<Error>
  • One returning Promise<void>

},
header: 'x-forwarded-authorization'
})
Expand Down