Interface Router

Should return a URL relative to the project base. This is used for determining links to items in the assets folder.

Should 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.

Get 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.

Get a list of all targets which can be linked to. This is used for creating the search index.

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.

Returns true if the target has its own page, false if embedded within another page.

Can be used to check if the target can be linked to.

Should return a URL which when clicked on the page containing from takes the user to the page/anchor containing to.