Skip to content

Commit 0534e92

Browse files
ivandotvgithub-actions[bot]
ivandotv
authored and
github-actions[bot]
committed
Generate docs
1 parent 2a4668e commit 0534e92

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

‎lib/koa-api/docs/api/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Koa API options
4444

4545
#### Defined in
4646

47-
[lib/koa-api/src/koa-api.ts:33](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L33)
47+
[lib/koa-api/src/koa-api.ts:33](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L33)
4848

4949
---
5050

@@ -65,7 +65,7 @@ Koa API options
6565

6666
#### Defined in
6767

68-
[lib/koa-api/src/koa-api.ts:17](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L17)
68+
[lib/koa-api/src/koa-api.ts:17](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L17)
6969

7070
## Functions
7171

@@ -77,19 +77,19 @@ Attaches router to a particular path. Internally it setups a prefix on the route
7777

7878
#### Parameters
7979

80-
| Name | Type | Description |
81-
| :------- | :------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------- |
82-
| `path` | `string` | path to attach the router to |
83-
| `app` | [`KoaApi`](classes/KoaApi.md)<`any`, `any`\> | - |
84-
| `router` | [`Router`](classes/Router.md)<[`DefaultState`](interfaces/Koa.DefaultState.md), [`DefaultContext`](interfaces/Koa.DefaultContext.md)\> | router to attach |
80+
| Name | Type | Description |
81+
| :------- | :------------------------------------------- | :--------------------------- |
82+
| `path` | `string` | path to attach the router to |
83+
| `app` | [`KoaApi`](classes/KoaApi.md)<`any`, `any`\> | - |
84+
| `router` | [`Router`](classes/Router.md)<`any`, `any`\> | router to attach |
8585

8686
#### Returns
8787

8888
`void`
8989

9090
#### Defined in
9191

92-
[lib/koa-api/src/koa-api.ts:108](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L108)
92+
[lib/koa-api/src/koa-api.ts:108](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L108)
9393

9494
---
9595

@@ -125,4 +125,4 @@ It should be used as default export from the Next.js api route file
125125

126126
#### Defined in
127127

128-
[lib/koa-api/src/koa-api.ts:99](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L99)
128+
[lib/koa-api/src/koa-api.ts:99](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L99)

‎lib/koa-api/docs/api/classes/KoaApi.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696

9797
#### Defined in
9898

99-
[lib/koa-api/src/koa-api.ts:54](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L54)
99+
[lib/koa-api/src/koa-api.ts:54](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L54)
100100

101101
## Properties
102102

@@ -232,7 +232,7 @@ node_modules/.pnpm/@[email protected]/node_modules/@types/koa/index.d.ts:456
232232

233233
#### Defined in
234234

235-
[lib/koa-api/src/koa-api.ts:48](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L48)
235+
[lib/koa-api/src/koa-api.ts:48](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L48)
236236

237237
---
238238

@@ -1292,7 +1292,7 @@ Run koa api with request and response objects
12921292

12931293
#### Defined in
12941294

1295-
[lib/koa-api/src/koa-api.ts:78](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L78)
1295+
[lib/koa-api/src/koa-api.ts:78](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L78)
12961296

12971297
---
12981298

‎lib/koa-api/docs/api/interfaces/Koa.Request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ node_modules/.pnpm/@[email protected]/node_modules/@types/koa/index.d.ts:703
105105

106106
#### Defined in
107107

108-
[lib/koa-api/src/koa-api.ts:10](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L10)
108+
[lib/koa-api/src/koa-api.ts:10](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L10)
109109

110110
---
111111

‎lib/koa-api/docs/api/modules/Koa.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ node_modules/.pnpm/@[email protected]/node_modules/@types/koa/index.d.ts:541
5858

5959
#### Defined in
6060

61-
[lib/koa-api/src/koa-api.ts:7](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L7)
61+
[lib/koa-api/src/koa-api.ts:7](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L7)
6262

6363
---
6464

@@ -122,7 +122,7 @@ node_modules/.pnpm/@[email protected]/node_modules/@types/koa/index.d.ts:736
122122

123123
#### Defined in
124124

125-
[lib/koa-api/src/koa-api.ts:8](https://github.com/ivandotv/nextjs-koa-api/blob/35b7030/lib/koa-api/src/koa-api.ts#L8)
125+
[lib/koa-api/src/koa-api.ts:8](https://github.com/ivandotv/nextjs-koa-api/blob/2a4668e/lib/koa-api/src/koa-api.ts#L8)
126126

127127
## Variables
128128

0 commit comments

Comments
 (0)