Skip to content

Function: getKeyValues() ​

ts
function getKeyValues(doc): FormField[];

Defined in: src/helpers/forms/formFields.ts:11

Extract every form field from a PDF as a flat list, one entry per widget.

Ports pymupdf4llm.helpers.utils.get_key_values. Each returned record carries the field's name, current value, type (text / checkbox / radio / choice / signature), the page number it appears on, and its bounding box.

Parameters ​

doc ​

PDFDocument

Returns ​

FormField[]

AGPL-3.0-or-later — inherited from PyMuPDF and pymupdf4llm.