Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArgdownPluginError

IArgdownPlugin implementations are expected to check in their IArgdownPlugin.prepare method that all required data is available in the response object. If this is not the case, they should throw an ArgdownPluginError.

Hierarchy

  • Error
    • ArgdownPluginError

Index

Constructors

Properties

Constructors

constructor

  • new ArgdownPluginError(plugin: string, code: string, message: string): ArgdownPluginError

  • Parameters

    • plugin: string

      the nname of the plugin throwing this error

    • code: string
    • message: string

      the reason why this error was thrown

    Returns ArgdownPluginError

Properties

Optional code

code: string

Type of error

plugin

plugin: string

The name of the plugin throwing the error.

Optional processor

processor: string

The name of the processor the plugin is a part of. Will be added automatically by ArgdownApplication.

Generated using TypeDoc