From c7218c0bd7aefb20f8d5c933210bfd5ebf2b89e0 Mon Sep 17 00:00:00 2001
From: Patrik <patrik@payloadcms.com>
Date: Wed, 4 Dec 2024 10:21:55 -0500
Subject: [PATCH] chore: adds jsdocs for `auth.forgotPassword.expiration` prop
 (#9739)

### 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
  */
```
---
 packages/payload/src/auth/types.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/packages/payload/src/auth/types.ts b/packages/payload/src/auth/types.ts
index 98ec382c687..1b643fd810d 100644
--- a/packages/payload/src/auth/types.ts
+++ b/packages/payload/src/auth/types.ts
@@ -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