Skip to content

Commit

Permalink
chore(docs): run typegen (#938)
Browse files Browse the repository at this point in the history
Co-authored-by: cobraz <cobraz@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and cobraz committed Feb 7, 2023
1 parent abcb6a5 commit 0fb88b7
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 37 deletions.
10 changes: 3 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,16 @@ oidc-react

`Const` **AuthContext**: `Context`<`undefined` \| [`AuthContextProps`](interfaces/AuthContextProps.md)\>

[AuthContext](README.md#authcontext)

#### Defined in

[src/AuthContext.tsx:12](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContext.tsx#L12)
[src/AuthContext.tsx:9](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContext.tsx#L9)

## Functions

### AuthProvider

**AuthProvider**(`props`, `context?`): ``null`` \| `ReactElement`<`any`, `any`\>

@

#### Parameters

| Name | Type | Description |
Expand Down Expand Up @@ -68,7 +64,7 @@ ___

#### Defined in

[src/useAuth.ts:6](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/useAuth.ts#L6)
[src/useAuth.ts:6](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/useAuth.ts#L6)

___

Expand Down Expand Up @@ -96,4 +92,4 @@ A public higher-order component to access the imperative API

#### Defined in

[src/withAuth.tsx:8](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/withAuth.tsx#L8)
[src/withAuth.tsx:8](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/withAuth.tsx#L8)
14 changes: 7 additions & 7 deletions docs/interfaces/AuthContextProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Auth state: True until the library has been initialized.

#### Defined in

[src/AuthContextInterface.ts:151](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L151)
[src/AuthContextInterface.ts:151](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L151)

___

Expand All @@ -50,7 +50,7 @@ Alias for userManager.signInRedirect

#### Defined in

[src/AuthContextInterface.ts:127](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L127)
[src/AuthContextInterface.ts:127](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L127)

___

Expand All @@ -70,7 +70,7 @@ Alias for userManager.signinPopup

#### Defined in

[src/AuthContextInterface.ts:131](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L131)
[src/AuthContextInterface.ts:131](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L131)

___

Expand All @@ -90,7 +90,7 @@ Alias for removeUser

#### Defined in

[src/AuthContextInterface.ts:135](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L135)
[src/AuthContextInterface.ts:135](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L135)

___

Expand All @@ -114,7 +114,7 @@ ___

#### Defined in

[src/AuthContextInterface.ts:139](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L139)
[src/AuthContextInterface.ts:139](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L139)

___

Expand All @@ -126,7 +126,7 @@ See [User](https://authts.github.io/oidc-client-ts/classes/User.html) for more d

#### Defined in

[src/AuthContextInterface.ts:147](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L147)
[src/AuthContextInterface.ts:147](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L147)

___

Expand All @@ -138,4 +138,4 @@ See [UserManager](https://authts.github.io/oidc-client-ts/classes/UserManager.ht

#### Defined in

[src/AuthContextInterface.ts:143](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L143)
[src/AuthContextInterface.ts:143](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L143)
40 changes: 20 additions & 20 deletions docs/interfaces/AuthProviderProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The URL of the OIDC/OAuth2 provider.

#### Defined in

[src/AuthContextInterface.ts:34](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L34)
[src/AuthContextInterface.ts:34](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L34)

___

Expand All @@ -49,7 +49,7 @@ defaults to true

#### Defined in

[src/AuthContextInterface.ts:76](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L76)
[src/AuthContextInterface.ts:76](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L76)

___

Expand All @@ -63,7 +63,7 @@ defaults to false

#### Defined in

[src/AuthContextInterface.ts:82](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L82)
[src/AuthContextInterface.ts:82](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L82)

___

Expand All @@ -75,7 +75,7 @@ Your client application's identifier as registered with the OIDC/OAuth2 provider

#### Defined in

[src/AuthContextInterface.ts:42](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L42)
[src/AuthContextInterface.ts:42](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L42)

___

Expand All @@ -87,7 +87,7 @@ Client secret defined on the identity server.

#### Defined in

[src/AuthContextInterface.ts:46](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L46)
[src/AuthContextInterface.ts:46](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L46)

___

Expand All @@ -99,7 +99,7 @@ Extra query params passed to the authorization url.

#### Defined in

[src/AuthContextInterface.ts:38](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L38)
[src/AuthContextInterface.ts:38](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L38)

___

Expand All @@ -113,7 +113,7 @@ defaults to true

#### Defined in

[src/AuthContextInterface.ts:88](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L88)
[src/AuthContextInterface.ts:88](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L88)

___

Expand All @@ -125,7 +125,7 @@ Defaults to `windows.location`.

#### Defined in

[src/AuthContextInterface.ts:72](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L72)
[src/AuthContextInterface.ts:72](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L72)

___

Expand All @@ -147,7 +147,7 @@ This only gets called if autoSignIn is true

#### Defined in

[src/AuthContextInterface.ts:111](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L111)
[src/AuthContextInterface.ts:111](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L111)

___

Expand All @@ -173,7 +173,7 @@ On sign out hook. Can be a async function.

#### Defined in

[src/AuthContextInterface.ts:116](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L116)
[src/AuthContextInterface.ts:116](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L116)

___

Expand All @@ -199,7 +199,7 @@ On sign out hook. Can be a async function.

#### Defined in

[src/AuthContextInterface.ts:120](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L120)
[src/AuthContextInterface.ts:120](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L120)

___

Expand All @@ -211,7 +211,7 @@ The URL for the page containing the call to signinPopupCallback to handle the ca

#### Defined in

[src/AuthContextInterface.ts:99](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L99)
[src/AuthContextInterface.ts:99](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L99)

___

Expand All @@ -225,7 +225,7 @@ defaults to 'location=no,toolbar=no,width=500,height=500,left=100,top=100'

#### Defined in

[src/AuthContextInterface.ts:94](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L94)
[src/AuthContextInterface.ts:94](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L94)

___

Expand All @@ -239,7 +239,7 @@ defaults to '_blank'

#### Defined in

[src/AuthContextInterface.ts:105](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L105)
[src/AuthContextInterface.ts:105](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L105)

___

Expand All @@ -251,7 +251,7 @@ The post-logout redirect URI of your client application which your OIDC/OAuth2 p

#### Defined in

[src/AuthContextInterface.ts:58](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L58)
[src/AuthContextInterface.ts:58](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L58)

___

Expand All @@ -263,7 +263,7 @@ The redirect URI of your client application to receive a response from the OIDC/

#### Defined in

[src/AuthContextInterface.ts:50](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L50)
[src/AuthContextInterface.ts:50](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L50)

___

Expand All @@ -277,7 +277,7 @@ Read more: https://tools.ietf.org/html/rfc6749#section-3.1.1

#### Defined in

[src/AuthContextInterface.ts:64](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L64)
[src/AuthContextInterface.ts:64](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L64)

___

Expand All @@ -289,7 +289,7 @@ A space-delimited list of permissions that the application requires.

#### Defined in

[src/AuthContextInterface.ts:68](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L68)
[src/AuthContextInterface.ts:68](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L68)

___

Expand All @@ -301,7 +301,7 @@ The redirect URI of your client application to receive a response from the OIDC/

#### Defined in

[src/AuthContextInterface.ts:54](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L54)
[src/AuthContextInterface.ts:54](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L54)

___

Expand All @@ -313,4 +313,4 @@ See [UserManager](https://github.com/authts/oidc-client-ts) for more details.

#### Defined in

[src/AuthContextInterface.ts:30](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L30)
[src/AuthContextInterface.ts:30](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L30)
2 changes: 1 addition & 1 deletion docs/interfaces/AuthProviderSignOutProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ const config = {

#### Defined in

[src/AuthContextInterface.ts:23](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L23)
[src/AuthContextInterface.ts:23](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L23)
4 changes: 2 additions & 2 deletions docs/interfaces/Location.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

#### Defined in

[src/AuthContextInterface.ts:4](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L4)
[src/AuthContextInterface.ts:4](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L4)

___

Expand All @@ -27,4 +27,4 @@ ___

#### Defined in

[src/AuthContextInterface.ts:3](https://github.com/jamesdh/oidc-react/blob/9b4c378/src/AuthContextInterface.ts#L3)
[src/AuthContextInterface.ts:3](https://github.com/bjerkio/oidc-react/blob/abcb6a5/src/AuthContextInterface.ts#L3)

0 comments on commit 0fb88b7

Please sign in to comment.