Create new Component instance.
The name of this component as set by the
Hooks which will be called when rendering pages. Note:
See RendererHooks for a description of each available hook, and when it will be called.
The theme that is used to render the documentation.
Return the application / root component instance.
Return the owner of this component.
Adds a new resolver that the theme can used to try to figure out how to link to a symbol declared by a third-party library which is not included in the documentation.
the npm package name that this resolver can handle to limit which files it will be tried on.
If the resolver will create links for Node builtin types, it should be set to
Links for builtin types live in the default lib files under
a function that will be called to create links for a given symbol name in the registered path.
If the provided name is not contained within the docs, should return
Marked as internal for now. Using this requires the internal
getSymbol() method on ReferenceType.
Someday that needs to be fixed so that this can be made public. ReferenceTypes really shouldn't store
symbols so that we don't need to keep the program around forever.
Define a new theme that can be used to render output. This API will likely be changing at some point, to allow more easily overriding parts of the theme without requiring additional boilerplate.
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
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.
Render the given project reflection to the specified output directory.
The project that should be rendered.
The path of the directory the documentation should be rendered to.
Tell this object to stop listening to either specific events ... or to every object it's currently listening to.
Optionalname: string | EventMap
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
The renderer processes a ProjectReflection using a Theme instance and writes the emitted html documents to a output directory. You can specify which theme should be used using the
--theme <name>command line argument.
Renderer is a subclass of EventDispatcher and triggers a series of events while a project is being processed. You can listen to these events to control the flow or manipulate the output.
Triggered before the renderer starts rendering a project. The listener receives an instance of RendererEvent. By calling preventDefault the entire render process can be canceled.
Triggered before a document will be rendered. The listener receives an instance of PageEvent. By calling preventDefault the generation of the document can be canceled.
Triggered after a document has been rendered, just before it is written to disc. The listener receives an instance of PageEvent. When calling preventDefault the the document will not be saved to disc.
Triggered after the renderer has written all documents. The listener receives an instance of RendererEvent.