API Documentation, Public Type Annotations and Workflow Updates#29
Merged
mehmet-kozan merged 4 commits intomainfrom Oct 18, 2025
Merged
API Documentation, Public Type Annotations and Workflow Updates#29mehmet-kozan merged 4 commits intomainfrom
mehmet-kozan merged 4 commits intomainfrom
Conversation
Renamed several workflow files for backup purposes. Updated triggers for test, integration, and unsupported test workflows to run on push to main, pull requests, and workflow_dispatch. Enabled package-manager cache in test workflow and commented out NPM cache cleaning step.
Added climate-change.pdf and climate.pdf to reports/pdf. Updated test cases in large-file.test.ts and url.test.ts to use local GitHub Pages PDF assets instead of external URLs for more reliable and consistent testing. Added @public JSDoc annotations to exception classes in src/Exception.ts for improved documentation. Minor workflow improvements in test.yml for Node.js setup and npm install.
Added and refined JSDoc @public annotations and documentation for exported classes, interfaces, and types across core modules. This improves API clarity and TypeScript documentation, making public API surfaces explicit for consumers.
Associate tsdoc-metadata.json with JSONC in VS Code settings. Enable 'includeForgottenExports' and update reportFolder in api-extractor.json for improved API documentation output.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces improvements across workflow configuration, API documentation, and exception handling. The most significant changes include enhanced public API documentation for core types and exceptions, more robust and descriptive error classes, and updates to GitHub Actions workflows for better caching and triggering. These updates improve maintainability, developer experience, and the clarity of the public API.
API Documentation and Public Type Annotations
@publicJSDoc annotations to all major exception classes, result containers, and type definitions insrc/Exception.ts,src/ImageResult.ts,src/InfoResult.ts, andsrc/PDFParse.ts, ensuring clear documentation and public visibility for consumers. (F9dc440bL3R3, [1] [2] [3]docs/README.api.mdto reflect new public annotations, improving the generated API reference for all exported classes and interfaces. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]Exception Handling Improvements
src/Exception.tswith detailed JSDoc comments, constructor documentation, and improved error messaging, making error handling more robust and developer-friendly. (F9dc440bL3R3, [1] [2] [3] [4] [5] [6]getExceptionutility to normalize thrown values and preserve type information, improving error mapping and diagnostics.GitHub Actions Workflow Updates
.github/workflows/test.yml, switching tolts/*Node.js, enabling npm caching, and optimizing install commands for faster and more reliable CI runs.workflow_dispatchwhere needed. [1] [2] [3] [4]Tooling and Configuration
api-extractor.jsonto include forgotten exports and adjust report folder location, ensuring the API extractor outputs more complete documentation. [1] [2] [3]tsdoc-metadata.jsonassociation to.vscode/settings.jsonfor improved editor support for JSONC files.Minor Documentation and Typo Fixes
PDFParseconstructor for clarity and consistency.Let me know if you want to discuss any specific part of these changes in more detail!