From 0534e92e704468aa461ec8d7921e603086dd4ce7 Mon Sep 17 00:00:00 2001 From: ivandotv Date: Wed, 1 Jun 2022 21:37:32 +0000 Subject: [PATCH] Generate docs --- lib/koa-api/docs/api/README.md | 18 +++++++++--------- lib/koa-api/docs/api/classes/KoaApi.md | 6 +++--- lib/koa-api/docs/api/interfaces/Koa.Request.md | 2 +- lib/koa-api/docs/api/modules/Koa.md | 4 ++-- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/lib/koa-api/docs/api/README.md b/lib/koa-api/docs/api/README.md index a9eb7c4..77794dd 100644 --- a/lib/koa-api/docs/api/README.md +++ b/lib/koa-api/docs/api/README.md @@ -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) --- @@ -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 @@ -77,11 +77,11 @@ 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 @@ -89,7 +89,7 @@ Attaches router to a particular path. Internally it setups a prefix on the route #### 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) --- @@ -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) diff --git a/lib/koa-api/docs/api/classes/KoaApi.md b/lib/koa-api/docs/api/classes/KoaApi.md index 645632e..0793caa 100644 --- a/lib/koa-api/docs/api/classes/KoaApi.md +++ b/lib/koa-api/docs/api/classes/KoaApi.md @@ -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 @@ -232,7 +232,7 @@ node_modules/.pnpm/@types+koa@2.13.4/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) --- @@ -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) --- diff --git a/lib/koa-api/docs/api/interfaces/Koa.Request.md b/lib/koa-api/docs/api/interfaces/Koa.Request.md index 5fea9e7..f871628 100644 --- a/lib/koa-api/docs/api/interfaces/Koa.Request.md +++ b/lib/koa-api/docs/api/interfaces/Koa.Request.md @@ -105,7 +105,7 @@ node_modules/.pnpm/@types+koa@2.13.4/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) --- diff --git a/lib/koa-api/docs/api/modules/Koa.md b/lib/koa-api/docs/api/modules/Koa.md index 66fc3ff..6dbda41 100644 --- a/lib/koa-api/docs/api/modules/Koa.md +++ b/lib/koa-api/docs/api/modules/Koa.md @@ -58,7 +58,7 @@ node_modules/.pnpm/@types+koa@2.13.4/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) --- @@ -122,7 +122,7 @@ node_modules/.pnpm/@types+koa@2.13.4/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