@vercel/edge 中的 TypeDoc 使用

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

我發現了一個名為 typedoc.json 的文件，讓我想知道什麼是 TypeDoc，快速的谷歌搜尋幫助我找到了 TypeDoc 網站。

那麼什麼是 TypeDoc？

TypeDoc

TypeDoc 將 TypeScript 原始碼中的註解轉換為渲染的 HTML 文件或 JSON 模型。它是可擴展的並支援多種配置。可作為 CLI 或節點模組使用。

TypeDoc 文件很全面。現在讓我們專注於@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
}

當您使用 CLI 執行 TypeDoc 時，您需要此設定。

注意“out”值，它是“docs”，這是一件好事，我們已經為@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 }
 * })
 * }
 *

*/
標頭？ ：標頭；
}

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 資料夾中套用了 prettier。

關於我們：

在 Think Throo，我們的使命是教授開源專案中使用的高階程式碼庫架構概念。

透過在 Next.js/React 中練習高階架構概念，將您的編碼技能提高 10 倍，學習最佳實踐並建立生產級專案。

我們是開源的 — https://github.com/thinkthroo/thinkthroo （請給我們一顆星！）

我們也提供網頁開發和技術寫作服務。請透過hello@thinkthroo.com聯絡我們以了解更多資訊！

參考資料：

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 使用的詳細內容。更多資訊請關注PHP中文網其他相關文章！