Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

typedoc-plugin-banish

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

typedoc-plugin-banish

A plugin for [TypeDoc](https://typedoc.org/) which filters reflections according to their declaration location, like `--exclude` but better since it also catches inherited items.

  • 1.0.1
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
2
increased by100%
Maintainers
1
Weekly downloads
 
Created
Source

typedoc-plugin-banish

A plugin for TypeDoc which filters reflections according to their declaration location, like --exclude but better since it also catches inherited items.

This plugin adds two options:

OptionDefaultDescription
banish["**/node_modules/**"]Array of minimatch patterns to match declaration locations against. If any match, the item will not be included in the documentation.
invertBanishfalseIf set, only include declarations whose locations are matched by banish

TypeDoc automatically loads plugins, so all you need to do to use this plugin is install it. If you selectively load plugins, add it to your plugins array in typedoc.json

{
  "banish": ["**/node_modules/**", "**/src/internal.ts"],
  "invertBanish": false,
  "plugins": ["typedoc-plugin-banish"]
}

Keywords

FAQs

Package last updated on 03 Sep 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc