npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@fly/typedoc-plugin-external-module-name

v1.1.3

Published

Specify the Typedoc Module of a file using @module annotation

Downloads

7

Readme

typedoc-plugin-external-module-name

Greenkeeper badge

What

A plugin for Typedoc

When using ES6 modules in Typedoc, each file gets its own listing in "External Modules", i.e., "Globals". This can be annoying, for projects that utilize one file per class, for instance.

Suppose your source files are organized like this:

thing1/foo.ts
thing1/bar.ts
thing2/baz.ts
thing2/qux.ts

Typedoc will create four "External Modules":

  • "thing1/foo"
  • "thing1/bar"
  • "thing2/baz"
  • "thing2/qux"

This plugin allows each file to specify the Typedoc External Module its code should belong to. If multiple files belong to the same module, they are merged.

This allows more control over the modules that Typedoc generates. Instead of the four modules above, we could group them into two:

  • thing1
  • thing2

Installing

Typedoc 0.4 has the ability to discover and load typedoc plugins found in node_modules. Simply install the plugin and run typedoc.

npm install --save typedoc-plugin-external-module-name
typedoc

Using

Add a comment block at the top of the file (ES6 module). Specify the Typedoc External Module using the @module annotation.

thing1/foo.ts

/**
 * @module thing1
 */

// foo stuff

thing1/bar.ts

/**
 * @module thing1
 */

// bar stuff

thing2/baz.ts

/**
 * @module thing2
 */

// baz stuff

Multiple files may point to the same ES6 module. To specify the which file's comment block will be used to document the Typedoc Module page, use @preferred

thing2/qux.ts

/**
 * @module thing2
 * @preferred
 *
 * This comment will be used to document the "thing2" module.
 */

// qux stuff