Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupPlugin

Creates groups from sections.

Transforms the response.map.nodes array into a tree of group nodes containing statement, argument or other group nodes as children.

If a statement or argument has no section, it will remain a root element of the tree.

This plugin should be run after the MapPlugin

Hierarchy

  • GroupPlugin

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

defaults

defaults: IGroupSettings

name

name: string = "GroupPlugin"

The name of the plugin

prepare

prepare: IRequestHandler = ...

Called each time the plugin's processor is run, before any other method of this plugin is called. Use this to add default settings to the request and to check that all required data is present in the response. If not, throw an ArgdownPluginError to cancel the the current processor's execution.

run

run: IRequestHandler = ...

Use this method to do the main work outside of the Argdown AST. This is the last method to be called by the ArgdownApplication.

Methods

getSettings

Generated using TypeDoc