From 49c70eff414f045c3f640069c9f7e0671ab3c247 Mon Sep 17 00:00:00 2001 From: Marco Date: Mon, 20 Apr 2020 21:02:57 +0200 Subject: [PATCH] Document return value of 'Auth#resetPassword' in README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 1d66818..413d301 100644 --- a/README.md +++ b/README.md @@ -350,6 +350,8 @@ catch (\Delight\Auth\TooManyRequestsException $e) { } ``` +If you need the user’s ID or email address, e.g. for sending them a notification that their password has successfully been reset, just use the return value of `Auth#resetPassword`, which is an array containing two entries named `id` and `email`. + ### Changing the current user’s password If a user is currently logged in, they may change their password.