View Source ArkeAuth.Core.User (arke_auth v0.1.9)
Documentation for User
.
Link to this section Summary
Link to this section Functions
@spec check_password(user :: ArkeAuth.Core.Unit.t(), pwd :: String.t()) :: {:ok, ArkeAuth.Core.Unit.t()} | Arke.Utils.ErrorGenerator.t()
Check if the given password is right
parameters
Parameters
- user => %Arke.Core.Unit{} => user struct
- pwd => string => password to check
return
Return
{:ok, %Arke.Core.Unit{}}
@spec update_password(user :: ArkeAuth.Core.Unit.t(), new_pwd :: String.t()) :: {:ok, ArkeAuth.Core.Unit.t()} | Arke.Utils.ErrorGenerator.t()
Update the user password
parameters
Parameters
- user => %Arke.Core.Unit{} => user struct
- new_pwd => string => password to check
return
Return
{:ok, %Arke.Core.Unit{}}