diff --git a/src/GoTrueAdminApi.ts b/src/GoTrueAdminApi.ts index 8f4ee2ba..79f19839 100644 --- a/src/GoTrueAdminApi.ts +++ b/src/GoTrueAdminApi.ts @@ -260,7 +260,7 @@ export default class GoTrueAdminApi { * Delete a user. Requires a `service_role` key. * * @param id The user id you want to remove. - * @param shouldSoftDelete If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema. + * @param shouldSoftDelete If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible. * Defaults to false for backward compatibility. * * This function should only be called on a server. Never expose your `service_role` key in the browser.