Penggunaan TypeDoc dalam @vercel/edge

Dalam artikel ini, kami menganalisis penggunaan TypeDoc dalam pakej @vercel/edge.

Saya menjumpai fail bernama typedoc.json, membuatkan saya tertanya-tanya apa itu TypeDoc dan carian google pantas membantu saya mencari tapak web TypeDoc.

Jadi apa itu TypeDoc?

TypeDoc

TypeDoc menukar ulasan dalam kod sumber TypeScript ke dalam dokumentasi HTML yang diberikan atau model JSON. Ia boleh dipanjangkan dan menyokong pelbagai konfigurasi. Tersedia sebagai modul CLI atau Nod.

Dokumentasi TypeDoc adalah menyeluruh. Sekarang mari kita fokus pada cara ini digunakan dalam @vercel/edge.

konfigurasi typedoc.json dalam @vercel/edge:

Kod di bawah dipilih daripada 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
}

Anda memerlukan konfigurasi ini apabila anda menggunakan CLI untuk menjalankan TypeDoc.

Beri perhatian kepada nilai "keluar", ia adalah "dokumen", adalah perkara yang baik bahawa kami telah pun menghasilkan dokumen untuk pakej @vercel/edge

Antara muka ModifiedRequest:

Mari pilih antara muka ModifiedRequest yang terdapat dalam 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 }
 * })
 * }
 *

*/
pengepala?: Pengepala;
}

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

Anda boleh melihat lebih cantik digunakan pada folder dokumen.

Tentang kami:

Di Think Throo, kami berada dalam misi untuk mengajar konsep seni bina asas kod lanjutan yang digunakan dalam projek sumber terbuka.

10x kemahiran pengekodan anda dengan mempraktikkan konsep seni bina lanjutan dalam Next.js/React, pelajari amalan terbaik dan bina projek gred pengeluaran.

Kami adalah sumber terbuka — https://github.com/thinkthroo/thinkthroo (Beri kami bintang!)

Kami juga menyediakan pembangunan web dan perkhidmatan penulisan teknikal. Hubungi kami di hello@thinkthroo.com untuk mengetahui lebih lanjut!

Rujukan:

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

Atas ialah kandungan terperinci Penggunaan TypeDoc dalam @vercel/edge. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!