README.md

oidc-react

oidc-react

Table of contents

Interfaces

• AuthContextProps
• AuthProviderProps
• AuthProviderSignOutProps
• Location

Variables

• AuthContext

Functions

• AuthProvider
• useAuth
• withAuth

Variables

AuthContext

• Const AuthContext: Context<undefined | AuthContextProps>

Defined in

src/auth-context.tsx:24

Functions

AuthProvider

▸ AuthProvider(props, context?): ReactNode

Parameters

Name	Type	Description
props	PropsWithChildren<AuthProviderProps>	AuthProviderProps
context?	any	-

Returns

ReactNode

Defined in

node_modules/.pnpm/@types+react@18.2.37/node_modules/@types/react/index.d.ts:567

---

useAuth

▸ useAuth(): AuthContextProps

Returns

AuthContextProps

Defined in

src/use-auth.ts:6

---

withAuth

▸ withAuth<P>(Component): React.ComponentType<Omit<P, keyof AuthContextProps>>

A public higher-order component to access the imperative API

Type parameters

Name	Type
P	extends AuthContextProps

Parameters

Name	Type
Component	ComponentType<P>

Returns

React.ComponentType<Omit<P, keyof AuthContextProps>>

Defined in

src/with-auth.tsx:8