Skip to content

Conversation

@Fdawgs
Copy link
Owner

@Fdawgs Fdawgs commented Nov 10, 2025

Checklist

@Fdawgs Fdawgs requested a review from Copilot November 10, 2025 12:56
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refactors the API documentation by extracting inline JSDoc parameter definitions into reusable typedef types for all PDF utility methods. This improves maintainability and provides better type checking support.

Key changes:

  • Introduced 11 new typedef types for method options (PdfAttachOptions, PdfDetachOptions, PdfFontsOptions, etc.)
  • Replaced verbose inline parameter documentation with references to the new typedef types
  • Updated both source code (src/index.js) and generated API documentation (API.md)

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/index.js Added 11 typedef type definitions and updated all method signatures to reference these types instead of inline parameter documentation
API.md Regenerated API documentation reflecting the new typedef structure with dedicated sections for each options type
Comments suppressed due to low confidence (1)

API.md:1

  • Missing space between 'features' and 'plus' in the description. Should be 'features plus'.
## Classes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Fdawgs Fdawgs merged commit 7a4736b into main Nov 10, 2025
18 checks passed
@Fdawgs Fdawgs deleted the chore/typedefs branch November 10, 2025 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants