Add TypeScript type definitions #205
Open
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.
Summary
This PR adds comprehensive TypeScript type definitions to the links-notation JavaScript package, enabling better developer experience for TypeScript users.
Changes
Core Implementation
js/index.d.ts- Complete TypeScript type definitions for all exported classes and functionsLinkclass with all methods and propertiesParserclass with configurable optionsFormatOptionsandFormatConfigclasses for formatting configurationLinksGroupclass for grouping related linksformatLinksfunction for bulk formattingConfiguration
js/package.json"types": "index.d.ts"field to reference type definitionsDocumentation & Examples
✅ Created
js/examples/typescript-example.ts- Comprehensive example demonstrating:✅ Updated
js/README.md- Added TypeScript usage section with:Testing & Validation
js/tsconfig.json- TypeScript configuration for developmentBenefits
This implementation provides TypeScript users with:
Example Usage
Testing
All tests continue to pass, and the type definitions have been validated:
Fixes
Fixes #198
Ready for review! This implementation provides complete TypeScript support while maintaining full backward compatibility with existing JavaScript code.