Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JSONExportPlugin

Exports data in the response object to JSON. The result ist stored in the [[IJSONResponse.json]] response object property.

Note: The IArgdownResponse.ast object is not exported to JSON.

Depends on data from: ModelPlugin Can use data from: [[TagPlugin]], DataPlugin, MapPlugin

Hierarchy

  • JSONExportPlugin

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

defaults

defaults: IJSONSettings

name

name: string = "JSONExportPlugin"

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