package
Extract documentation from TypeScript files. Based on deno_doc.
npm install tsdoc-extractorGitHub-flavored package documentation.
Across all versions, last 30 days.
222 in 30 days
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
2.8 MB
Includes dependencies.
Extract documentation from TypeScript files. Based on deno_doc.
$ npm install tsdoc-extractorproduct.ts
/**
* This is a product
*/
export interface Product {
id: string;
}Let's extract the documentation:
import { doc } from "tsdoc-extractor";
const url = new URL("product.ts", import.meta.url).toString();
const nodes = await doc(url);
console.log(nodes[0]);
/*
{
"kind": "interface",
"name": "Product",
"location": {
"filename": "file:///tmp/product.ts",
"line": 4,
"col": 0
},
"declarationKind": "export",
"jsDoc": {
"doc": "This is a product"
},
"interfaceDef": {
"extends": [],
"methods": [],
product.ts
import { Reference } from "my-dependency";
/**
* This is a product
*/
export interface Product {
id: string;
ref: Reference;
}To resolve the types from a dependency, you need to provide a custom resolve method:
import { doc, defaultResolver } from "tsdoc-extractor";
const url = new URL("product.ts", import.meta.url).toString();
const nodes = await doc(url, {
resolve: function (specifier, referrer) {
if (specifier === "my-dependency") {
return "file:///Projects/my-project/node_modules/my-dependency/dist/index.d.ts";
// or "file:///Projects/my-project/node_modules/my-dependency/index.ts";
// or "file:///Projects/my-project/node_modules/@types/my-dependency/index.d.ts";
} else {
return defaultResolver(specifier, referrer);
}
}
});