Options
All
  • Public
  • Public/Protected
  • All
Menu

Compiles source files using TypeScript and converts compiler symbols to reflections.

Hierarchy

  • ChildableComponent<Application, ConverterComponent>
    • Converter

Index

Constructors

constructor

Events

Static Readonly EVENT_BEGIN

EVENT_BEGIN: "begin" = ConverterEvents.BEGIN

Triggered when the converter begins converting a project. The listener will be given a Context object.

Static Readonly EVENT_CREATE_DECLARATION

EVENT_CREATE_DECLARATION: "createDeclaration" = ConverterEvents.CREATE_DECLARATION

Triggered when the converter has created a declaration reflection. The listener will be given Context, Reflection and a ts.Node?.

Static Readonly EVENT_CREATE_PARAMETER

EVENT_CREATE_PARAMETER: "createParameter" = ConverterEvents.CREATE_PARAMETER

Triggered when the converter has created a parameter reflection. The listener will be given Context, ParameterReflection and a ts.Node?

Static Readonly EVENT_CREATE_SIGNATURE

EVENT_CREATE_SIGNATURE: "createSignature" = ConverterEvents.CREATE_SIGNATURE

Triggered when the converter has created a signature reflection. The listener will be given Context, SignatureReflection and a ts.Node?

Static Readonly EVENT_CREATE_TYPE_PARAMETER

EVENT_CREATE_TYPE_PARAMETER: "createTypeParameter" = ConverterEvents.CREATE_TYPE_PARAMETER

Triggered when the converter has created a type parameter reflection. The listener will be given Context, TypeParameterReflection and a ts.Node?

Static Readonly EVENT_END

EVENT_END: "end" = ConverterEvents.END

Triggered when the converter has finished converting a project. The listener will be given a Context object.

Static Readonly EVENT_RESOLVE

EVENT_RESOLVE: "resolveReflection" = ConverterEvents.RESOLVE

Triggered when the converter resolves a reflection. The listener will be given Context and a Reflection.

Static Readonly EVENT_RESOLVE_BEGIN

EVENT_RESOLVE_BEGIN: "resolveBegin" = ConverterEvents.RESOLVE_BEGIN

Triggered when the converter begins resolving a project. The listener will be given Context.

Static Readonly EVENT_RESOLVE_END

EVENT_RESOLVE_END: "resolveEnd" = ConverterEvents.RESOLVE_END

Triggered when the converter has finished resolving a project. The listener will be given Context.

Properties

componentName

componentName: string

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

excludeExternals

excludeExternals: boolean

excludeNotDocumented

excludeNotDocumented: boolean

excludePrivate

excludePrivate: boolean

excludeProtected

excludeProtected: boolean

externalPattern

externalPattern: string[]

name

name: string

The human readable name of the project. Used within the templates to set the title of the document.

Accessors

application

owner

  • get owner(): O

Methods

addComponent

  • addComponent<T>(name: string, componentClass: T | ComponentClass<T, Application>): T
  • Type parameters

    • T: ConverterComponent<T>

    Parameters

    • name: string
    • componentClass: T | ComponentClass<T, Application>

    Returns T

Protected bubble

convert

getComponent

  • getComponent(name: string): undefined | ConverterComponent
  • Retrieve a plugin instance.

    Parameters

    • name: string

    Returns undefined | ConverterComponent

    The instance of the plugin or undefined if no plugin with the given class is attached.

getComponents

  • getComponents(): ConverterComponent[]

hasComponent

  • hasComponent(name: string): boolean

Protected initialize

  • initialize(): void

listenTo

  • Inversion-of-control versions of on. Tell this object to listen to an event in another object... keeping track of what it's listening to for easier unbinding later.

    Parameters

    Returns Converter

listenToOnce

off

on

once

  • 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

    Returns Converter

  • Parameters

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

    Returns Converter

removeAllComponents

  • removeAllComponents(): void

removeComponent

  • removeComponent(name: string): undefined | ConverterComponent
  • Parameters

    • name: string

    Returns undefined | ConverterComponent

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 Converter

Generated using TypeDoc