AbstractProtectedincludeProtectedsluggerShould return a URL relative to the project base. This is used for determining links to items in the assets folder.
ProtectedbuildProtectedbuildShould return a list of pages which should be rendered. This will be called once per render.
Gets an anchor for this target within its containing page. May be undefined if this target owns its own page.
ProtectedgetGet the full URL to the target. In TypeDoc's default router this
is equivalent to relativeUrl(project, refl), but this might not be
the case for custom routers which place the project somewhere else
besides index.html.
The URL returned by this by the frontend JS when building dynamic URLs for the search, full hierarchy, and navigation components.
Protected AbstractgetShould return the base-relative desired file name for a router target. This name may not be used exactly as TypeDoc will detect conflicts and automatically introduce a unique identifier to the URL to resolve them.
Get a list of all targets which can be linked to. This is used for creating the search index.
ProtectedgetShould the page kind to use if a reflection should have its own rendered
page in the output. Note that once undefined is returned, children of
that reflection will not have their own document.
Responsible for getting a slugger for the given target. If a target is not associated with a page, the slugger for the parent target should be returned instead.
ProtectedgetStrip non-url safe characters from the specified string.
Returns true if the target has its own page, false if embedded within another page.
Should return a URL which when clicked on the page containing from
takes the user to the page/anchor containing to.
Base router class intended to make it easier to implement a router.
Child classes need only getIdealBaseName, this class will take care of the recursing through child reflections.