Hook providing operations and corresponding state for authenticating with an
Atlas App with Email/Password. It also contains operations related to
Email/Password authentication, such as resetting password and confirming a user.
The AuthResult values returned from this hook (e.g. state, pending, etc.) are
shared across all components under a given AppProvider, as only one operation can be in
progress at a given time (i.e. we will store the values on the context). This means that,
for example, multiple components can use the useEmailPasswordAuth hook to access
result.pending to render a spinner when login is in progress, without
needing to pass that state around or store it somewhere global in their app
code.
Returns UseEmailPasswordAuth
An object containing operations and state related to Email/Password authentication.
Hook providing operations and corresponding state for authenticating with an Atlas App with Email/Password. It also contains operations related to Email/Password authentication, such as resetting password and confirming a user.
The AuthResult values returned from this hook (e.g.
state,pending, etc.) are shared across all components under a givenAppProvider, as only one operation can be in progress at a given time (i.e. we will store the values on the context). This means that, for example, multiple components can use theuseEmailPasswordAuthhook to accessresult.pendingto render a spinner when login is in progress, without needing to pass that state around or store it somewhere global in their app code.