chore: adding description on types

Orfium · Jul 26, 2023 · 46aaf91 · 46aaf91
1 parent de159ce
commit 46aaf91
Show file tree

Hide file tree

Showing 9 changed files with 594 additions and 592 deletions.
diff --git a/documentation/docs/api/classes/BrowserRouter.md b/documentation/docs/api/classes/BrowserRouter.md
diff --git a/documentation/docs/api/classes/Redirect.md b/documentation/docs/api/classes/Redirect.md
diff --git a/documentation/docs/api/classes/Route.md b/documentation/docs/api/classes/Route.md
diff --git a/documentation/docs/api/interfaces/AxiosPromise.md b/documentation/docs/api/interfaces/AxiosPromise.md
@@ -1,16 +1,16 @@
 ---
-id: 'AxiosPromise'
-title: 'Interface: AxiosPromise<T>'
-sidebar_label: 'AxiosPromise'
+id: "AxiosPromise"
+title: "Interface: AxiosPromise<T>"
+sidebar_label: "AxiosPromise"
 sidebar_position: 0
 custom_edit_url: null
 ---
 
 ## Type parameters
 
-| Name | Type  |
-| :--- | :---- |
-| `T`  | `any` |
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
 
 ## Hierarchy
 
@@ -26,7 +26,7 @@ custom_edit_url: null
 
 #### Inherited from
 
-Promise.\_\_@toStringTag@6618
+Promise.\_\_@toStringTag@6616
 
 #### Defined in
 
@@ -42,15 +42,15 @@ Attaches a callback for only the rejection of the Promise.
 
 #### Type parameters
 
-| Name      | Type    |
-| :-------- | :------ |
+| Name | Type |
+| :------ | :------ |
 | `TResult` | `never` |
 
 #### Parameters
 
-| Name          | Type                                                                  | Description                                           |
-| :------------ | :-------------------------------------------------------------------- | :---------------------------------------------------- |
-| `onrejected?` | `null` \| (`reason`: `any`) => `TResult` \| `PromiseLike`<`TResult`\> | The callback to execute when the Promise is rejected. |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult` \| `PromiseLike`<`TResult`\> | The callback to execute when the Promise is rejected. |
 
 #### Returns
 
@@ -66,7 +66,7 @@ Promise.catch
 
 documentation/node_modules/typescript/lib/lib.es5.d.ts:1509
 
----
+___
 
 ### finally
 
@@ -77,9 +77,9 @@ resolved value cannot be modified from the callback.
 
 #### Parameters
 
-| Name         | Type                   | Description                                                                  |
-| :----------- | :--------------------- | :--------------------------------------------------------------------------- |
-| `onfinally?` | `null` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `onfinally?` | ``null`` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). |
 
 #### Returns
 
@@ -95,7 +95,7 @@ Promise.finally
 
 documentation/node_modules/typescript/lib/lib.es2018.promise.d.ts:31
 
----
+___
 
 ### then
 
@@ -105,17 +105,17 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
 
 #### Type parameters
 
-| Name       | Type                                      |
-| :--------- | :---------------------------------------- |
+| Name | Type |
+| :------ | :------ |
 | `TResult1` | [`AxiosResponse`](AxiosResponse.md)<`T`\> |
-| `TResult2` | `never`                                   |
+| `TResult2` | `never` |
 
 #### Parameters
 
-| Name           | Type                                                                                                       | Description                                           |
-| :------------- | :--------------------------------------------------------------------------------------------------------- | :---------------------------------------------------- |
-| `onfulfilled?` | `null` \| (`value`: [`AxiosResponse`](AxiosResponse.md)<`T`\>) => `TResult1` \| `PromiseLike`<`TResult1`\> | The callback to execute when the Promise is resolved. |
-| `onrejected?`  | `null` \| (`reason`: `any`) => `TResult2` \| `PromiseLike`<`TResult2`\>                                    | The callback to execute when the Promise is rejected. |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `onfulfilled?` | ``null`` \| (`value`: [`AxiosResponse`](AxiosResponse.md)<`T`\>) => `TResult1` \| `PromiseLike`<`TResult1`\> | The callback to execute when the Promise is resolved. |
+| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| `PromiseLike`<`TResult2`\> | The callback to execute when the Promise is rejected. |
 
 #### Returns