README.md

PDF Form Extract

Extracts PDF form fields into a Javascript object.

Installation

npm install @cityssm/pdf-form-extract

Usage

import extractFormFields from "@cityssm/pdf-form-extract"

const data = await extractFormFields('test/testForm.pdf')
console.log(data)

const dataWithOptions = await extractFormFields('test/testForm.pdf', { useFieldName: true })

{
  "Contractor Firm Name": "The City of Sault Ste. Marie",
  "Address": "https://github.com/cityssm/pdf-form-extract",
  "Contractor Representative Print Name": "Dan Gowans",
  "Date": "2023-01-13"
}

Optional Options

useFieldName
Default = false
Uses the field name (provided by the Form API) as the Object key instead of the field key.

Notes

For the best results, the form fields in the PDF should be properly labelled.