Skip to content

Commit

Permalink
chore: adds jsdocs for auth.forgotPassword.expiration prop (#9739)
Browse files Browse the repository at this point in the history
### What

Updates auth.forgotPassword.expiration prop type to include JSDocs

I.e

```
/**
  * The number of milliseconds that the forgot password token should be valid for.
  * @default 3600000 // 1 hour
  */
```
  • Loading branch information
PatrikKozak authored Dec 4, 2024
1 parent 340bc85 commit c7218c0
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/payload/src/auth/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,10 @@ export interface IncomingAuthType {
* @link https://payloadcms.com/docs/authentication/email#forgot-password
*/
forgotPassword?: {
/**
* The number of milliseconds that the forgot password token should be valid for.
* @default 3600000 // 1 hour
*/
expiration?: number
generateEmailHTML?: GenerateForgotPasswordEmailHTML
generateEmailSubject?: GenerateForgotPasswordEmailSubject
Expand Down

0 comments on commit c7218c0

Please sign in to comment.