在本文中，我們分析了 @vercel/edge 包中的 TypeDoc 使用情況。

我發(fā)現(xiàn)了一個名為 typedoc.json 的文件，讓我想知道什么是 TypeDoc，快速的谷歌搜索幫助我找到了 TypeDoc 網(wǎng)站。

那么什么是 TypeDoc？

TypeDoc

TypeDoc 將 TypeScript 源代碼中的注釋轉(zhuǎn)換為渲染的 HTML 文檔或 JSON 模型。它是可擴(kuò)展的并支持多種配置?？勺鳛?CLI 或節(jié)點(diǎn)模塊使用。

TypeDoc 文檔很全面?，F(xiàn)在讓我們重點(diǎn)關(guān)注@vercel/edge 中如何使用它。

@vercel/edge 中的 typedoc.json 配置：

以下代碼摘自packages/edge/typedoc.json。

{
 "$schema": "https://typedoc.org/schema.json",
 "entryPoints": ["src/index.ts"],
 "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-mdn-links"],
 "out": "docs",
 "githubPages": false,
 "gitRevision": "main",
 "readme": "none",
 "hideBreadcrumbs": true
}

當(dāng)您使用 CLI 運(yùn)行 TypeDoc 時，您需要此配置。

注意“out”值，它是“docs”，這是一件好事，我們已經(jīng)為@vercel/edge包生成了文檔

修改請求接口：

讓我們選擇在 middleware-helpers.ts 中找到的 ModifiedRequest 接口

export interface ModifiedRequest {
 /**
 * If set, overwrites the incoming headers to the origin request.
 *
 * This is useful when you want to pass data between a Middleware and a
 * Serverless or Edge Function.
 *
 * @example
 * <caption>Add a `x-user-id` header and remove the `Authorization` header</caption>
 *
 * ```

ts
 * import { rewrite } from '@vercel/edge';
 * export default async function middleware(request: Request): Promise<Response> {
 * const newHeaders = new Headers(request.headers);
 * newHeaders.set('x-user-id', 'user_123');
 * newHeaders.delete('authorization');
 * return rewrite(request.url, {
 * request: { headers: newHeaders }
 * })
 * }
 *

*/
標(biāo)頭？：標(biāo)頭；
}

This interface has a comment added that is picked by TypeDoc and is made available in docs at [edge/docs/interfaces/ModifiedRequest.md](https://github.com/vercel/vercel/blob/main/packages/edge/docs/interfaces/ModifiedRequest.md)

But what’s the command this package uses to initiate documentation generation? It can be found in [package.json](https://github.com/vercel/vercel/blob/main/packages/edge/package.json#L19)



```plaintext
"build:docs": "typedoc && node scripts/fix-links.js && prettier - write docs/**/*.md docs/*.md",

您可以看到 docs 文件夾中應(yīng)用了 prettier。

關(guān)于我們：

在 Think Throo，我們的使命是教授開源項(xiàng)目中使用的高級代碼庫架構(gòu)概念。

通過在 Next.js/React 中練習(xí)高級架構(gòu)概念，將您的編碼技能提高 10 倍，學(xué)習(xí)最佳實(shí)踐并構(gòu)建生產(chǎn)級項(xiàng)目。

我們是開源的 — https://github.com/thinkthroo/thinkthroo （請給我們一顆星?。?/p>

我們還提供網(wǎng)絡(luò)開發(fā)和技術(shù)寫作服務(wù)。請通過hello@thinkthroo.com聯(lián)系我們了解更多信息！

參考資料：

1. https://github.com/vercel/vercel/blob/main/packages/edge/typedoc.jso

2. https://github.com/TypeStrong/typedoc

3. https://typedoc.org/

4. https://github.com/vercel/vercel/blob/main/packages/edge/docs

5. https://github.com/vercel/vercel/blob/main/packages/edge/docs/interfaces/ModifiedRequest.md

6. https://github.com/vercel/vercel/blob/main/packages/edge/src/middleware-helpers.ts#L1

以上是@vercel/edge 中的 TypeDoc 使用的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！