TypeDoc-Nutzung in @vercel/edge

In diesem Artikel analysieren wir die TypeDoc-Nutzung im @vercel/edge-Paket.

Ich habe eine Datei namens typedoc.json gefunden, mich gefragt, was TypeDoc ist, und eine schnelle Google-Suche hat mir geholfen, die TypeDoc-Website zu finden.

Was ist also TypeDoc?

TypeDoc

TypeDoc konvertiert Kommentare im TypeScript-Quellcode in gerenderte HTML-Dokumentation oder ein JSON-Modell. Es ist erweiterbar und unterstützt eine Vielzahl von Konfigurationen. Verfügbar als CLI- oder Node-Modul.

Die TypeDoc-Dokumentation ist umfassend. Konzentrieren wir uns nun darauf, wie dies in @vercel/edge verwendet wird.

typedoc.json-Konfiguration in @vercel/edge:

Der folgende Code wird aus packets/edge/typedoc.json ausgewählt.

{
 "$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
}

Sie benötigen diese Konfiguration, wenn Sie CLI verwenden, um TypeDoc auszuführen.

Achten Sie auf den Wert „out“, es handelt sich um „docs“. Es ist gut, dass wir bereits Dokumente für das @vercel/edge-Paket generiert haben

ModifiedRequest-Schnittstelle:

Wählen wir die ModifiedRequest-Schnittstelle aus middleware-helpers.ts

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?: Header;
}

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

Sie können sehen, dass „prettier“ auf den Dokumentenordner angewendet wird.

Über uns:

Bei Think Throo haben wir die Mission, die fortgeschrittenen Codebasis-Architekturkonzepte zu vermitteln, die in Open-Source-Projekten verwendet werden.

Verzehnfachen Sie Ihre Programmierkenntnisse, indem Sie fortgeschrittene Architekturkonzepte in Next.js/React üben, die Best Practices erlernen und Projekte in Produktionsqualität erstellen.

Wir sind Open Source – https://github.com/thinkthroo/thinkthroo (Geben Sie uns einen Stern!)

Wir bieten auch Webentwicklungs- und technische Redaktionsdienste an. Kontaktieren Sie uns unter hello@thinkthroo.com, um mehr zu erfahren!

Referenzen:

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

Das obige ist der detaillierte Inhalt vonTypeDoc-Nutzung in @vercel/edge. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!