withAuthHeader¶

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

Import¶

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

Function Signature¶

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

Type Parameters¶

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

Parameters¶

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

Returns¶

React.FunctionComponent<P>

React Higher Order Component with injected authHeader prop.

React HOC that injects the auth header into the class-based component props

Format: type token (authType-space-authToken)

Example¶

class MyComponent extends React.Component {
 render() {
   return <h1>Hello, {this.props.authHeader}</h1>;
 }
}
export default withAuthHeader(MyComponent);

Throws¶

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

Defined in¶

higherOrderComponents/withAuthHeader.tsx

— 🔑 —

React Auth Kit is MIT License code