modern-pdf-lib

---

modern-pdf-lib / checkAccessibility

Function: checkAccessibility()

checkAccessibility(doc): AccessibilityIssue[]

Defined in: src/accessibility/accessibilityChecker.ts:62

Check a PDF document for accessibility issues.

This function examines the document's structure tree, metadata, and page content to identify potential accessibility problems. It returns an array of AccessibilityIssue objects, each describing a specific issue with its severity, code, and human-readable message.

Parameters

doc

PdfDocument

The PDF document to check.

Returns

AccessibilityIssue[]

An array of accessibility issues (empty if no issues found).

Example

import { createPdf } from 'modern-pdf-lib';
import { checkAccessibility } from 'modern-pdf-lib/accessibility';

const doc = createPdf();
const issues = checkAccessibility(doc);
for (const issue of issues) {
  console.log(`[${issue.severity}] ${issue.code}: ${issue.message}`);
}