docs: add JSDoc comments to types/index.ts (Fixes #9)#32
Open
clawwoo2026 wants to merge 1 commit intoanxkhn:mainfrom
Open
docs: add JSDoc comments to types/index.ts (Fixes #9)#32clawwoo2026 wants to merge 1 commit intoanxkhn:mainfrom
clawwoo2026 wants to merge 1 commit intoanxkhn:mainfrom
Conversation
- Add comprehensive JSDoc documentation to all type definitions - Document EventStatus and EventCategory type unions - Add property-level documentation for Event interface - Add property-level documentation for EventFormData interface - Document ApiError, PaginatedResponse, EventFilters, and SortOptions - Follow TSDoc format with proper @template tags where applicable This improves developer experience when using TypeScript intellisense and helps new contributors understand the data structures.
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
1 participant
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
Adds comprehensive JSDoc documentation to all type definitions.
Changes
Fixes #9