Create new Component instance.
Triggered when the converter begins converting a project. The listener should implement [[IConverterCallback]].
Triggered when the converter has created a declaration reflection. The listener should implement [[IConverterNodeCallback]].
Triggered when the converter has created a parameter reflection. The listener should implement [[IConverterNodeCallback]].
Triggered when the converter has created a signature reflection. The listener should implement [[IConverterNodeCallback]].
Triggered when the converter has created a type parameter reflection. The listener should implement [[IConverterNodeCallback]].
Triggered when the converter has finished converting a project. The listener should implement [[IConverterCallback]].
Triggered when the converter resolves a reflection. The listener should implement [[IConverterResolveCallback]].
Triggered when the converter begins resolving a project. The listener should implement [[IConverterCallback]].
Triggered when the converter has finished resolving a project. The listener should implement [[IConverterCallback]].
Compile the files within the given context and convert the compiler symbols to reflections.
The name of this component as set by the @Component decorator.
The human readable name of the project. Used within the templates to set the title of the document.
Resolve the project within the given context.
A unique id that identifies this instance.
Return the application / root component instance.
Return the owner of this component.
Compile the given source files and create a project reflection for them.
the entry points of this program.
Retrieve a plugin instance.
The instance of the plugin or undefined if no plugin with the given class is attached.
Initialize this component.
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.
Inversion-of-control versions of once
.
Remove one or many callbacks. If context
is null, removes all
callbacks with that function. If callback
is null, removes all
callbacks for the event. If name
is null, removes all bound
callbacks for all events.
Bind an event to a callback
function. Passing "all"
will bind
the callback to all events fired.
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.
Tell this object to stop listening to either specific events ... or to every object it's currently listening to.
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).
Generated using TypeDoc
Compiles source files using TypeScript and converts compiler symbols to reflections.