Skip to content

formatBrokenLinks

Formats broken links into a human-readable multi-line report.

Import:

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

Signature:

function formatBrokenLinks(brokenLinks: BrokenLink[]): string

Parameters:

Parameter Type Description
brokenLinks BrokenLink[] The broken links to describe.

Returns: string — One line per broken link.