Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options

The interface of the Options object

Hierarchy

  • Options

Index

Properties

Optional exclude

exclude: RegExp | RegExp[]

A RegExp or an array of RegExp whose matching paths will be ignored. Default: /node_modules/

Optional extensions

extensions: string[]

An array of strings representing the extensions that will be considered. Default undefined, all extensions will be considered

Optional indent

indent: undefined | false | true

If the generated code will be indented the same as the comment it will substitute. Default: true

Optional log

log: undefined | false | true

If the log will be shown on the terminal. Default: true

Generated using TypeDoc