Represents a broken or invalid link found during validation.
Contains detailed information about the link, where it was found, and why it's considered broken. Used for reporting and debugging link integrity issues.
Handling broken links
const brokenLinks: BrokenLink[] = validationResult.brokenLinks;brokenLinks.forEach(broken => { console.log(`${broken.sourceFile}:`); console.log(` Link: ${broken.link.href}`); console.log(` Reason: ${broken.reason}`); if (broken.details) { console.log(` Details: ${broken.details}`); }}); Copy
const brokenLinks: BrokenLink[] = validationResult.brokenLinks;brokenLinks.forEach(broken => { console.log(`${broken.sourceFile}:`); console.log(` Link: ${broken.link.href}`); console.log(` Reason: ${broken.reason}`); if (broken.details) { console.log(` Details: ${broken.details}`); }});
Optional
Authentication information if applicable
Additional error details
Content freshness information for external links
The broken link
Reason the link is broken
File containing the broken link
Represents a broken or invalid link found during validation.
Contains detailed information about the link, where it was found, and why it's considered broken. Used for reporting and debugging link integrity issues.
Example
Handling broken links