withSignOut¶

Deprecated Higher-order components are not commonly used in modern React code, use Hooks instead

Import¶

import withSignOut from 'react-auth-kit/higherOrderComponents/withSignOut';

withSignOut<P>(Component): React.FunctionComponent<P>

Name	Type	Description
`P`	extends `withSignOutProps`	Props of the component

Name	Type	Description
`Component`	`ComponentType`<`P`>	React Class based Component

React.FunctionComponent\<P>

React Higher Order Component with injected signOut prop

React HOC that injects the signOut function into the class-based component props.

Call the signOut function in the prop to sign out and delete all the auth state

This will remove the authState from memory and also remove the stored data from cookie or localstorage

Here's a simple example:

class MyComponent extends React.Component {
 this.props.signOut();
 ...
}
export default withSignOut(MyComponent);

For Now, this hook doesn't redirect automatically. So one needs to write the redirect logic himself.

AuthError - Thrown if the Hook is used outside the Provider Scope.

— 🔑 —

React Auth Kit is MIT License code