Skip to content

TypeScript API / @laikacms/server/oauth2 / requestPasswordReset

Function: requestPasswordReset() ​

ts
function requestPasswordReset(user, config): Promise<{
  error?: string;
  success: boolean;
}>;

Request a password reset for a user. Generates a secure token, stores it, and sends a reset email.

Parameters ​

ParameterTypeDescription
userUser-
configPasswordResetConfigPassword reset configuration

Returns ​

Promise<{ error?: string; success: boolean; }>

Result indicating success or failure

Example ​

typescript
const result = await requestPasswordReset('user@example.com', {
  emailProvider: myEmailProvider,
  callbacks: myCallbacks,
  resetBaseUrl: 'https://example.com/reset-password',
  fromEmail: 'noreply@example.com',
  appName: 'My CMS',
});

if (result.success) {
  console.log('Reset email sent');
}

Released under the MIT License.