Skip to content

Commit 1f0ac96

Browse files
chore(docs): run typegen (#1122)
Co-authored-by: simenandre <3726815+simenandre@users.noreply.github.com>
1 parent 0fec510 commit 1f0ac96

File tree

10 files changed

+143
-199
lines changed

10 files changed

+143
-199
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**oidc-react****Docs**
1+
**oidc-react**
22

33
***
44

@@ -14,9 +14,9 @@
1414
## Variables
1515

1616
- [AuthContext](variables/AuthContext.md)
17+
- [AuthProvider](variables/AuthProvider.md)
1718

1819
## Functions
1920

20-
- [AuthProvider](functions/AuthProvider.md)
2121
- [useAuth](functions/useAuth.md)
2222
- [withAuth](functions/withAuth.md)

docs/functions/AuthProvider.md

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

docs/functions/useAuth.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**oidc-react**](../README.md)**Docs**
1+
[**oidc-react**](../README.md)
22

33
***
44

@@ -8,10 +8,8 @@
88

99
> **useAuth**(): [`AuthContextProps`](../interfaces/AuthContextProps.md)
1010
11+
Defined in: [use-auth.ts:6](https://github.com/bjerkio/oidc-react/blob/main/src/use-auth.ts#L6)
12+
1113
## Returns
1214

1315
[`AuthContextProps`](../interfaces/AuthContextProps.md)
14-
15-
## Defined in
16-
17-
[src/use-auth.ts:6](https://github.com/bjerkio/oidc-react/blob/main/src/use-auth.ts#L6)

docs/functions/withAuth.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
1-
[**oidc-react**](../README.md)**Docs**
1+
[**oidc-react**](../README.md)
22

33
***
44

55
[oidc-react](../README.md) / withAuth
66

77
# Function: withAuth()
88

9-
> **withAuth**\<`P`\>(`Component`): `React.ComponentType`\<`Omit`\<`P`, keyof [`AuthContextProps`](../interfaces/AuthContextProps.md)\>\>
9+
> **withAuth**\<`P`\>(`Component`): `ComponentType`\<`Omit`\<`P`, keyof [`AuthContextProps`](../interfaces/AuthContextProps.md)\>\>
10+
11+
Defined in: [with-auth.tsx:8](https://github.com/bjerkio/oidc-react/blob/main/src/with-auth.tsx#L8)
1012

1113
A public higher-order component to access the imperative API
1214

1315
## Type Parameters
1416

15-
**P** *extends* [`AuthContextProps`](../interfaces/AuthContextProps.md)
17+
### P
18+
19+
`P` *extends* [`AuthContextProps`](../interfaces/AuthContextProps.md)
1620

1721
## Parameters
1822

19-
**Component**: `ComponentType`\<`P`\>
23+
### Component
2024

21-
## Returns
25+
`ComponentType`\<`P`\>
2226

23-
`React.ComponentType`\<`Omit`\<`P`, keyof [`AuthContextProps`](../interfaces/AuthContextProps.md)\>\>
24-
25-
## Defined in
27+
## Returns
2628

27-
[src/with-auth.tsx:8](https://github.com/bjerkio/oidc-react/blob/main/src/with-auth.tsx#L8)
29+
`ComponentType`\<`Omit`\<`P`, keyof [`AuthContextProps`](../interfaces/AuthContextProps.md)\>\>
Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,113 +1,119 @@
1-
[**oidc-react**](../README.md)**Docs**
1+
[**oidc-react**](../README.md)
22

33
***
44

55
[oidc-react](../README.md) / AuthContextProps
66

77
# Interface: AuthContextProps
88

9+
Defined in: [auth-context-interface.ts:153](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L153)
10+
911
## Properties
1012

1113
### isLoading
1214

1315
> **isLoading**: `boolean`
1416
15-
Auth state: True until the library has been initialized.
16-
17-
#### Defined in
17+
Defined in: [auth-context-interface.ts:185](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L185)
1818

19-
[src/auth-context-interface.ts:181](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L181)
19+
Auth state: True until the library has been initialized.
2020

2121
***
2222

2323
### signIn()
2424

25-
> **signIn**: (`args`?) => `Promise`\<`void`\>
25+
> **signIn**: (`args?`) => `Promise`\<`void`\>
26+
27+
Defined in: [auth-context-interface.ts:157](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L157)
2628

2729
Alias for userManager.signInRedirect
2830

2931
#### Parameters
3032

31-
**args?**: `SigninRedirectArgs`
33+
##### args?
34+
35+
`SigninRedirectArgs`
3236

3337
#### Returns
3438

3539
`Promise`\<`void`\>
3640

37-
#### Defined in
41+
***
42+
43+
### signInCallback()
3844

39-
[src/auth-context-interface.ts:157](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L157)
45+
> **signInCallback**: () => `Promise`\<`void`\>
46+
47+
Defined in: [auth-context-interface.ts:161](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L161)
48+
49+
Alias for userManager.signInCallback
50+
51+
#### Returns
52+
53+
`Promise`\<`void`\>
4054

4155
***
4256

4357
### signInPopup()
4458

4559
> **signInPopup**: () => `Promise`\<`void`\>
4660
61+
Defined in: [auth-context-interface.ts:165](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L165)
62+
4763
Alias for userManager.signinPopup
4864

4965
#### Returns
5066

5167
`Promise`\<`void`\>
5268

53-
#### Defined in
54-
55-
[src/auth-context-interface.ts:161](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L161)
56-
5769
***
5870

5971
### signOut()
6072

6173
> **signOut**: () => `Promise`\<`void`\>
6274
75+
Defined in: [auth-context-interface.ts:169](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L169)
76+
6377
Alias for removeUser
6478

6579
#### Returns
6680

6781
`Promise`\<`void`\>
6882

69-
#### Defined in
70-
71-
[src/auth-context-interface.ts:165](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L165)
72-
7383
***
7484

7585
### signOutRedirect()
7686

77-
> **signOutRedirect**: (`args`?) => `Promise`\<`void`\>
87+
> **signOutRedirect**: (`args?`) => `Promise`\<`void`\>
88+
89+
Defined in: [auth-context-interface.ts:173](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L173)
7890

7991
#### Parameters
8092

81-
**args?**: `SignoutRedirectArgs`
93+
##### args?
94+
95+
`SignoutRedirectArgs`
8296

8397
#### Returns
8498

8599
`Promise`\<`void`\>
86100

87-
#### Defined in
88-
89-
[src/auth-context-interface.ts:169](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L169)
90-
91101
***
92102

93103
### userData?
94104

95105
> `optional` **userData**: `null` \| `User`
96106
97-
See [User](https://authts.github.io/oidc-client-ts/classes/User.html) for more details.
98-
99-
#### Defined in
107+
Defined in: [auth-context-interface.ts:181](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L181)
100108

101-
[src/auth-context-interface.ts:177](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L177)
109+
See [User](https://authts.github.io/oidc-client-ts/classes/User.html) for more details.
102110

103111
***
104112

105113
### userManager
106114

107115
> **userManager**: `UserManager`
108116
109-
See [UserManager](https://authts.github.io/oidc-client-ts/classes/UserManager.html) for more details.
110-
111-
#### Defined in
117+
Defined in: [auth-context-interface.ts:177](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L177)
112118

113-
[src/auth-context-interface.ts:173](https://github.com/bjerkio/oidc-react/blob/main/src/auth-context-interface.ts#L173)
119+
See [UserManager](https://authts.github.io/oidc-client-ts/classes/UserManager.html) for more details.

0 commit comments

Comments
 (0)