Skip to content

Commit 0105c42

Browse files
wintondeshongwintondeshong
committed
Rev'd to version 0.0.7
1 parent d477a7a commit 0105c42

12 files changed

Lines changed: 112 additions & 90 deletions

‎docs/README.md‎

Lines changed: 84 additions & 62 deletions
Large diffs are not rendered by default.

‎docs/interfaces/authenticatedroute.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
• **isAuthenticated**: *boolean*
2727

28-
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/authenticated-route.ts#L12)*
28+
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/authenticated-route.ts#L12)*
2929

3030
Flag to determine whether the current user is authenticated or not.
3131

@@ -37,7 +37,7 @@ ___
3737

3838
• **redirectToIfUnauthenticated**? : *undefined | string*
3939

40-
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/authenticated-route.ts#L20)*
40+
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/authenticated-route.ts#L20)*
4141

4242
Route to redirect to if the current user is not authenticated.
4343

‎docs/interfaces/authenticatedrouteprops.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ ___
4747

4848
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[isAuthenticated](authenticatedroute.md#isauthenticated)*
4949

50-
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/authenticated-route.ts#L12)*
50+
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/authenticated-route.ts#L12)*
5151

5252
Flag to determine whether the current user is authenticated or not.
5353

@@ -81,7 +81,7 @@ ___
8181

8282
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)*
8383

84-
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/authenticated-route.ts#L20)*
84+
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/authenticated-route.ts#L20)*
8585

8686
Route to redirect to if the current user is not authenticated.
8787

@@ -93,7 +93,7 @@ ___
9393

9494
• **render**: *function*
9595

96-
*Defined in [src/components/routing/authenticated-route.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/components/routing/authenticated-route.tsx#L14)*
96+
*Defined in [src/components/routing/authenticated-route.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/components/routing/authenticated-route.tsx#L14)*
9797

9898
#### Type declaration:
9999

@@ -111,7 +111,7 @@ ___
111111

112112
• **route**: *[RouteDefinition](routedefinition.md)*
113113

114-
*Defined in [src/components/routing/authenticated-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/components/routing/authenticated-route.tsx#L13)*
114+
*Defined in [src/components/routing/authenticated-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/components/routing/authenticated-route.tsx#L13)*
115115

116116
___
117117

‎docs/interfaces/nestedrouteprops.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[isAuthenticated](authenticatedroute.md#isauthenticated)*
2626

27-
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/authenticated-route.ts#L12)*
27+
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/authenticated-route.ts#L12)*
2828

2929
Flag to determine whether the current user is authenticated or not.
3030

@@ -38,7 +38,7 @@ ___
3838

3939
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)*
4040

41-
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/authenticated-route.ts#L20)*
41+
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/authenticated-route.ts#L20)*
4242

4343
Route to redirect to if the current user is not authenticated.
4444

@@ -50,4 +50,4 @@ ___
5050

5151
• **route**: *[RouteDefinition](routedefinition.md)*
5252

53-
*Defined in [src/components/routing/nested-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/components/routing/nested-route.tsx#L13)*
53+
*Defined in [src/components/routing/nested-route.tsx:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/components/routing/nested-route.tsx#L13)*

‎docs/interfaces/nestedroutesbypropertyprops.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919

2020
• **propertyName**: *keyof RouteDefinition*
2121

22-
*Defined in [src/components/routing/nested-routes-by-property.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/components/routing/nested-routes-by-property.tsx#L14)*
22+
*Defined in [src/components/routing/nested-routes-by-property.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/components/routing/nested-routes-by-property.tsx#L14)*
2323

2424
___
2525

2626
### routes
2727

2828
• **routes**: *[RouteDefinition](routedefinition.md)[]*
2929

30-
*Defined in [src/components/routing/nested-routes-by-property.tsx:15](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/components/routing/nested-routes-by-property.tsx#L15)*
30+
*Defined in [src/components/routing/nested-routes-by-property.tsx:15](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/components/routing/nested-routes-by-property.tsx#L15)*

‎docs/interfaces/nestedroutesprops.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[isAuthenticated](authenticatedroute.md#isauthenticated)*
2929

30-
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/authenticated-route.ts#L12)*
30+
*Defined in [src/interfaces/authenticated-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/authenticated-route.ts#L12)*
3131

3232
Flag to determine whether the current user is authenticated or not.
3333

@@ -41,7 +41,7 @@ ___
4141

4242
*Inherited from [UnmatchedRoute](unmatchedroute.md).[redirectToIfNotFound](unmatchedroute.md#optional-redirecttoifnotfound)*
4343

44-
*Defined in [src/interfaces/unmatched-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/unmatched-route.ts#L12)*
44+
*Defined in [src/interfaces/unmatched-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/unmatched-route.ts#L12)*
4545

4646
Route to redirect to if the specified route cannot be matched.
4747

@@ -55,7 +55,7 @@ ___
5555

5656
*Inherited from [AuthenticatedRoute](authenticatedroute.md).[redirectToIfUnauthenticated](authenticatedroute.md#optional-redirecttoifunauthenticated)*
5757

58-
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/authenticated-route.ts#L20)*
58+
*Defined in [src/interfaces/authenticated-route.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/authenticated-route.ts#L20)*
5959

6060
Route to redirect to if the current user is not authenticated.
6161

@@ -67,4 +67,4 @@ ___
6767

6868
• **routes**: *[RouteDefinition](routedefinition.md)[]*
6969

70-
*Defined in [src/components/routing/nested-routes.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/components/routing/nested-routes.tsx#L14)*
70+
*Defined in [src/components/routing/nested-routes.tsx:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/components/routing/nested-routes.tsx#L14)*

‎docs/interfaces/redirectdefinition.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919

2020
• **from**: *string*
2121

22-
*Defined in [src/interfaces/redirect-definition.ts:6](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/redirect-definition.ts#L6)*
22+
*Defined in [src/interfaces/redirect-definition.ts:6](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/redirect-definition.ts#L6)*
2323

2424
___
2525

2626
### to
2727

2828
• **to**: *string*
2929

30-
*Defined in [src/interfaces/redirect-definition.ts:7](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/redirect-definition.ts#L7)*
30+
*Defined in [src/interfaces/redirect-definition.ts:7](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/redirect-definition.ts#L7)*

‎docs/interfaces/redirectsprops.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818

1919
• **redirects**: *[RedirectDefinition](redirectdefinition.md)[]*
2020

21-
*Defined in [src/components/routing/redirects.tsx:10](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/components/routing/redirects.tsx#L10)*
21+
*Defined in [src/components/routing/redirects.tsx:10](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/components/routing/redirects.tsx#L10)*

‎docs/interfaces/routedefinition.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,52 +24,52 @@
2424

2525
• **authRequired**: *boolean*
2626

27-
*Defined in [src/interfaces/route-definition.ts:9](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/route-definition.ts#L9)*
27+
*Defined in [src/interfaces/route-definition.ts:9](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/route-definition.ts#L9)*
2828

2929
___
3030

3131
### component
3232

3333
• **component**: *React.ComponentType*
3434

35-
*Defined in [src/interfaces/route-definition.ts:10](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/route-definition.ts#L10)*
35+
*Defined in [src/interfaces/route-definition.ts:10](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/route-definition.ts#L10)*
3636

3737
___
3838

3939
### `Optional` exact
4040

4141
• **exact**? : *undefined | false | true*
4242

43-
*Defined in [src/interfaces/route-definition.ts:11](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/route-definition.ts#L11)*
43+
*Defined in [src/interfaces/route-definition.ts:11](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/route-definition.ts#L11)*
4444

4545
___
4646

4747
### `Optional` getComponent
4848

4949
• **getComponent**? : *undefined | function*
5050

51-
*Defined in [src/interfaces/route-definition.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/route-definition.ts#L12)*
51+
*Defined in [src/interfaces/route-definition.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/route-definition.ts#L12)*
5252

5353
___
5454

5555
### path
5656

5757
• **path**: *string*
5858

59-
*Defined in [src/interfaces/route-definition.ts:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/route-definition.ts#L13)*
59+
*Defined in [src/interfaces/route-definition.ts:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/route-definition.ts#L13)*
6060

6161
___
6262

6363
### routes
6464

6565
• **routes**: *[RouteMap](routemap.md)*
6666

67-
*Defined in [src/interfaces/route-definition.ts:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/route-definition.ts#L14)*
67+
*Defined in [src/interfaces/route-definition.ts:14](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/route-definition.ts#L14)*
6868

6969
___
7070

7171
### `Optional` sidebar
7272

7373
• **sidebar**? : *React.ComponentType*
7474

75-
*Defined in [src/interfaces/route-definition.ts:16](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/route-definition.ts#L16)*
75+
*Defined in [src/interfaces/route-definition.ts:16](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/route-definition.ts#L16)*

‎docs/interfaces/unmatchedroute.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
• **redirectToIfNotFound**? : *undefined | string*
2222

23-
*Defined in [src/interfaces/unmatched-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/528d171/src/interfaces/unmatched-route.ts#L12)*
23+
*Defined in [src/interfaces/unmatched-route.ts:12](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React/blob/d477a7a/src/interfaces/unmatched-route.ts#L12)*
2424

2525
Route to redirect to if the specified route cannot be matched.
2626

0 commit comments

Comments
 (0)