Skip to content

Commit b5333d9

Browse files
author
Simen A. W. Olsen
committed
update typedoc
1 parent 3743e6a commit b5333d9

File tree

9 files changed

+289
-838
lines changed

9 files changed

+289
-838
lines changed

docs/.nojekyll

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/README.md

Lines changed: 3 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,5 @@
1-
oidc-react
1+
**oidc-react****Docs**
22

3-
# oidc-react
4-
5-
## Table of contents
6-
7-
### Interfaces
8-
9-
- [AuthContextProps](interfaces/AuthContextProps.md)
10-
- [AuthProviderProps](interfaces/AuthProviderProps.md)
11-
- [AuthProviderSignOutProps](interfaces/AuthProviderSignOutProps.md)
12-
- [Location](interfaces/Location.md)
13-
14-
### Variables
15-
16-
- [AuthContext](README.md#authcontext)
17-
18-
### Functions
19-
20-
- [AuthProvider](README.md#authprovider)
21-
- [useAuth](README.md#useauth)
22-
- [withAuth](README.md#withauth)
23-
24-
## Variables
25-
26-
### AuthContext
27-
28-
`Const` **AuthContext**: `Context`\<`undefined` \| [`AuthContextProps`](interfaces/AuthContextProps.md)\>
29-
30-
#### Defined in
31-
32-
[src/auth-context.tsx:24](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context.tsx#L24)
33-
34-
## Functions
35-
36-
### AuthProvider
37-
38-
**AuthProvider**(`props`, `deprecatedLegacyContext?`): `ReactNode`
39-
40-
#### Parameters
41-
42-
| Name | Type | Description |
43-
| :------ | :------ | :------ |
44-
| `props` | `PropsWithChildren`\<[`AuthProviderProps`](interfaces/AuthProviderProps.md)\> | AuthProviderProps |
45-
| `deprecatedLegacyContext?` | `any` | **`Deprecated`** **`See`** [React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) |
46-
47-
#### Returns
48-
49-
`ReactNode`
50-
51-
#### Defined in
3+
***
524

53-
[src/auth-context.tsx:96](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context.tsx#L96)
54-
55-
___
56-
57-
### useAuth
58-
59-
**useAuth**(): [`AuthContextProps`](interfaces/AuthContextProps.md)
60-
61-
#### Returns
62-
63-
[`AuthContextProps`](interfaces/AuthContextProps.md)
64-
65-
#### Defined in
66-
67-
[src/use-auth.ts:6](https://github.com/bjerkio/oidc-react/blob/main/src/use-auth.ts#L6)
68-
69-
___
70-
71-
### withAuth
72-
73-
**withAuth**\<`P`\>(`Component`): `React.ComponentType`\<`Omit`\<`P`, keyof [`AuthContextProps`](interfaces/AuthContextProps.md)\>\>
74-
75-
A public higher-order component to access the imperative API
76-
77-
#### Type parameters
78-
79-
| Name | Type |
80-
| :------ | :------ |
81-
| `P` | extends [`AuthContextProps`](interfaces/AuthContextProps.md) |
82-
83-
#### Parameters
84-
85-
| Name | Type |
86-
| :------ | :------ |
87-
| `Component` | `ComponentType`\<`P`\> |
88-
89-
#### Returns
90-
91-
`React.ComponentType`\<`Omit`\<`P`, keyof [`AuthContextProps`](interfaces/AuthContextProps.md)\>\>
92-
93-
#### Defined in
94-
95-
[src/with-auth.tsx:8](https://github.com/bjerkio/oidc-react/blob/main/src/with-auth.tsx#L8)
5+
# oidc-react

docs/interfaces/AuthContextProps.md

Lines changed: 0 additions & 141 deletions
This file was deleted.

0 commit comments

Comments
 (0)