Skip to content

Commit

Permalink
fix: update soft-deletion docs (#973)
Browse files Browse the repository at this point in the history
## What kind of change does this PR introduce?

For clarity as it seems to be confusing users. Ticket linked internally.
  • Loading branch information
J0 authored Oct 21, 2024
1 parent 1b6cdd2 commit cb052a9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/GoTrueAdminApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit cb052a9

Please sign in to comment.