Skip to content

Commit

Permalink
Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ivandotv authored and github-actions[bot] committed Jun 1, 2022
1 parent 2a4668e commit 0534e92
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
18 changes: 9 additions & 9 deletions lib/koa-api/docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Koa API options

#### Defined in

[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)
[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)

---

Expand All @@ -65,7 +65,7 @@ Koa API options

#### Defined in

[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)
[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)

## Functions

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

#### Parameters

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

#### Returns

`void`

#### Defined in

[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)
[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)

---

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

#### Defined in

[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)
[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)
6 changes: 3 additions & 3 deletions lib/koa-api/docs/api/classes/KoaApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@

#### Defined in

[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)
[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)

## Properties

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

#### Defined in

[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)
[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)

---

Expand Down Expand Up @@ -1292,7 +1292,7 @@ Run koa api with request and response objects

#### Defined in

[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)
[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)

---

Expand Down
2 changes: 1 addition & 1 deletion lib/koa-api/docs/api/interfaces/Koa.Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ node_modules/.pnpm/@[email protected]/node_modules/@types/koa/index.d.ts:703

#### Defined in

[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)
[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)

---

Expand Down
4 changes: 2 additions & 2 deletions lib/koa-api/docs/api/modules/Koa.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ node_modules/.pnpm/@[email protected]/node_modules/@types/koa/index.d.ts:541

#### Defined in

[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)
[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)

---

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

#### Defined in

[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)
[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)

## Variables

Expand Down

0 comments on commit 0534e92

Please sign in to comment.