Is there a built-in way to rename an entire module (i.e. customize its name so that it's not just the filename)?

This issue has been tracked since 2023-02-08.

Search terms

rename, module, file, namespace

Question

Hi,

I have a file mminit.ts which defines a bunch of variables on the Window object. The name mminit is quite cryptic, and I'd like to rename it something like Window or DOMExtensions. I have a comment with the tag /** @module DOMExtensions */ at the top of the file, but it does nothing.

Is there a way to make the file show up in the documentation with a custom name other than mminit?
I could probably jury-rig it with a janky solution via a plugin, but I'd like to see if there's a built-in way first. I can't find anything in the documentation that seems to work, though.

Gerrit0 wrote this answer on 2023-02-18

I have a comment with the tag /** @module DOMExtensions */ at the top of the file, but it does nothing.

This is the way to go - is the comment the very first thing in the file, before any imports? It should do what you've described you want.

More Details About Repo
Owner Name TypeStrong
Repo Name typedoc
Full Name TypeStrong/typedoc
Language TypeScript
Created Date 2014-05-24
Updated Date 2023-03-19
Star Count 6487
Watcher Count 68
Fork Count 639
Issue Count 48

YOU MAY BE INTERESTED

Issue Title Created Date Updated Date