API Docs for:
Show:

BasePlugin Class

The base class for all DocPad plugins

Constructor

BasePlugin

()

Methods

constructor

(
  • opts
)

Constructor method for the plugin

Parameters:

  • opts Object

setConfig

(
  • [instanceConfig=null]
)
private

Set Configuration

Parameters:

  • [instanceConfig=null] Object optional

setInstanceConfig

(
  • instanceConfig
)
private

Set Instance Configuration

Parameters:

  • instanceConfig Object

() private

Get the Configuration

addListeners

() private

Add Listeners

bindEvents

() private

Alias for b/c

bindListeners

() private

Bind Listeners

destroy

() private

Destructor. Calls removeListeners

isEnabled

() Boolean

Is Enabled?

Returns:

Boolean:

removeListeners

() private

Remove Listeners

Properties

@extend

Object private

Add support for BasePlugin.extend(proto)

docpad

Object private

The DocPad Instance

String

The plugin name

Object

The plugin config

Object

The instance config.

Number private

Plugin priority