Skip to content

Commit c7218c0

Browse files
authored
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 */ ```
1 parent 340bc85 commit c7218c0

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

packages/payload/src/auth/types.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,10 @@ export interface IncomingAuthType {
221221
* @link https://payloadcms.com/docs/authentication/email#forgot-password
222222
*/
223223
forgotPassword?: {
224+
/**
225+
* The number of milliseconds that the forgot password token should be valid for.
226+
* @default 3600000 // 1 hour
227+
*/
224228
expiration?: number
225229
generateEmailHTML?: GenerateForgotPasswordEmailHTML
226230
generateEmailSubject?: GenerateForgotPasswordEmailSubject

0 commit comments

Comments
 (0)