Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PrettyPrintPlugin

A plugin that pretty prints the generated html.

This not only aids in making the generated html source code more readable, by removing blank lines and unnecessary whitespaces the size of the documentation is reduced without visual impact.

At the point writing this the docs of TypeDoc took 97.8 MB without and 66.4 MB with this plugin enabled, so it reduced the size to 68% of the original output.

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

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

Accessors

application

owner

Methods

Protected bubble

getOptionDeclarations

initialize

  • initialize(): void

listenTo

listenToOnce

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

onRendererEndPage

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

Object literals

Static IGNORED_TAGS

IGNORED_TAGS: object

Map of all tags that will be ignored.

area

area: boolean = true

base

base: boolean = true

br

br: boolean = true

col

col: boolean = true

command

command: boolean = true

embed

embed: boolean = true

hr

hr: boolean = true

img

img: boolean = true

input

input: boolean = true

link

link: boolean = true

meta

meta: boolean = true

param

param: boolean = true

source

source: boolean = true

wbr

wbr: boolean = true

Static PRE_TAGS

PRE_TAGS: object

Map of all tags that prevent this plugin form modifying the following code.

code

code: boolean = true

pre

pre: boolean = true

script

script: boolean = true

style

style: boolean = true

textarea

textarea: boolean = true

Generated using TypeDoc