Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PluginHost

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

The name of this component as set by the @Component decorator.

plugins

plugins: string[]

Accessors

application

owner

Methods

Protected bubble

Private discoverNpmPlugins

  • discoverNpmPlugins(): string[]
  • Discover all installed TypeDoc plugins.

    Returns string[]

    A list of all npm module names that are qualified TypeDoc plugins.

getOptionDeclarations

Protected initialize

  • initialize(): void

listenTo

listenToOnce

load

  • load(): boolean
  • Load the given list of npm plugins.

    Returns boolean

    TRUE on success, otherwise FALSE.

off

  • off(): any
  • off(eventMap: EventMap, context?: any): any
  • off(name: string, callback?: EventCallback, context?: any): any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: number): any

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns any

stopListening

trigger

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    Returns this

Generated using TypeDoc