Skip to content

Update jsdoc optional params compatibile with rollup to types file#87

Open
sparr wants to merge 1 commit intoscreepers:masterfrom
sparr:code_set_hash_optional
Open

Update jsdoc optional params compatibile with rollup to types file#87
sparr wants to merge 1 commit intoscreepers:masterfrom
sparr:code_set_hash_optional

Conversation

@sparr
Copy link
Copy Markdown

@sparr sparr commented Nov 27, 2025

@param {type?} paramname is not understood by the typescript plugin for generating dist/types/ScreepsAPI.d.ts, so the typings have various optional parameters incorrectly identified as not-optional.
[Some of] The recognized syntaxes are @param {type} [paramname] and @param {type} paramname=defaultvalue.

This PR makes this change in a few places. I ran npm run build and confirmed the desired changes to ScreepsAPI.d.ts.

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.

1 participant