Type the sitespeed.io context and queue message in JSDoc#4
Merged
Conversation
Plugin authors writing against this base class have no IDE help for the shape of context (the messageMaker/getLogger/filterRegistry/storageManager/ resultUrls hub) or for the queue messages they receive — the only way to discover the shape today is to read sitespeed.io's source. This change adds JSDoc typedefs for those objects so that editors offering JSDoc support can autocomplete context.storageManager, message.runIndex, and the rest without changing any runtime behaviour. Also drops the stale "UNRELEASED" marker on the 1.0.2 entry in CHANGELOG. Co-authored-by: Claude Opus 4.7 (1M context) [email protected]
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.
Plugin authors writing against this base class have no IDE help for the
shape of context (the messageMaker/getLogger/filterRegistry/storageManager/
resultUrls hub) or for the queue messages they receive — the only way to
discover the shape today is to read sitespeed.io's source. This change adds
JSDoc typedefs for those objects so that editors offering JSDoc support can
autocomplete context.storageManager, message.runIndex, and the rest
without changing any runtime behaviour. Also drops the stale "UNRELEASED"
marker on the 1.0.2 entry in CHANGELOG.
Co-authored-by: Claude Opus 4.7 (1M context) [email protected]