@vercel/edge での TypeDoc の使用法

この記事では、@vercel/edge パッケージでの TypeDoc の使用法を分析します。

typedoc.json という名前のファイルを見つけたので、TypeDoc とは何だろうと疑問に思いました。Google で簡単に検索すると、TypeDoc の Web サイトを見つけることができました。

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 パッケージ用に既にドキュメントが生成されているのは良いことです

ModifiedRequest インターフェース:

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 }
 * })
 * }
 *

*/
headers?: ヘッダー;
}

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",

prettier が docs フォルダーに適用されていることがわかります。

私たちについて:

Think Throo では、オープンソース プロジェクトで使用される高度なコードベース アーキテクチャの概念を教えることを使命としています。

Next.js/React の高度なアーキテクチャ概念を実践してコーディング スキルを 10 倍にし、ベスト プラクティスを学び、実稼働レベルのプロジェクトを構築します。

私たちはオープンソースです — https://github.com/thinkthroo/thinkthroo (スターを付けてください!)

当社では、Web 開発およびテクニカル ライティング サービスも提供しています。詳細については、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 中国語 Web サイトの他の関連記事を参照してください。