BrokenLink

A single link that does not resolve.

Import:

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

Signature:

export interface BrokenLink

Properties

Property	Type	Description
httpStatus?	number	The HTTP status returned by an external link, when BrokenLink.reason is external-error. 0 denotes a network-level failure (timeout, DNS, connection refused).
pageUrl	string	The absolute URL of the page that contains the broken link.
reason	'external-error' | 'missing-fragment' | 'missing-page'	Why the link is considered broken.
targetUrl	string	The resolved absolute URL the link points at.

---

Links to this page:

• collectBrokenExternalLinks
• collectBrokenLinks
• formatBrokenLinks