Module extractor[src]

ts-extractor

Extracts modules, classes, interfaces, enums, type aliases and constants from typescript projects.

Check out the documentation here.

Features

• Clear project structure - A project is made up of modules, and a "module" is either a folder or a namespace. Modules can contain other modules (sub-folders, other namespaces), or exported classes, interfaces, enums, functions, constants and types from each file inside the folder. This allows for very easy navigation.

• References - Every type reference provides a path which leads to the module it's declared in, which allows for super easy and painless linking.

• Monorepo support - Bundle types from all projects in the monorepo.

• JSDoc support - Extracts all JSDoc tags, along with their comments and type.

• External references - Easily add external references which can link to other documentation sites.

Install

npm i @ts-docs/extractor

Examples

External References

Let's assume you have some module which uses node-fetch and some of it's types. Supply the externals option in the extractor settings:

const extractor = new TypescriptExtractorclass TypescriptExtractorextractor/extractor/TypescriptExtractor({ 
    entryPoints: ["./entry-point.ts"],
    externals: [
        {
            run: (name) => {
                switch (name) {
                    case "Response": return "https://github.com/node-fetch/node-fetch#class-response";
                    case "Request": return "https://github.com/node-fetch/node-fetch#class-request";
                }
            }
        }
    ]
})