modern-pdf-lib

---

modern-pdf-lib / SignOptions

Interface: SignOptions

Defined in: src/signature/signatureHandler.ts:54

Options for signing a PDF.

Properties

appearance?

optional appearance: VisibleSignatureOptions

Defined in: src/signature/signatureHandler.ts:74

Visible signature appearance options. When provided, the signature field is rendered visibly on the specified page with text and optional styling. When omitted, the signature is invisible.

---

certificate

certificate: Uint8Array

Defined in: src/signature/signatureHandler.ts:56

DER-encoded X.509 certificate.

---

contactInfo?

optional contactInfo: string

Defined in: src/signature/signatureHandler.ts:66

Contact information.

---

hashAlgorithm?

optional hashAlgorithm: "SHA-256" | "SHA-384" | "SHA-512"

Defined in: src/signature/signatureHandler.ts:60

Hash algorithm. Default: 'SHA-256'.

---

location?

optional location: string

Defined in: src/signature/signatureHandler.ts:64

Location of signing.

---

privateKey

privateKey: Uint8Array

Defined in: src/signature/signatureHandler.ts:58

PKCS#8 DER-encoded private key.

---

reason?

optional reason: string

Defined in: src/signature/signatureHandler.ts:62

Reason for signing.

---

timestampUrl?

optional timestampUrl: string

Defined in: src/signature/signatureHandler.ts:68

RFC 3161 TSA URL for timestamping (optional).