Skip to content

isInternalDocUrl

Determines whether a resolved link points at a page hosted by this documentation site.

Import:

import { isInternalDocUrl } from '@mnaoumov/typescript-dev-toolkit/docs-site/link-check';

Signature:

function isInternalDocUrl(targetUrl: URL, siteBaseUrl: string): boolean

Parameters:

Parameter Type Description
targetUrl URL The resolved absolute link URL.
siteBaseUrl string The absolute base URL the site is served from (with a trailing slash).

Returns: boolean — true when the link is same-origin and under the site base path.


Links to this page: