Skip to content

Fix TypeDoc parse error on DeferredPromise typedef - #4125

Merged
DmitrySharabin merged 1 commit into
v2from
fix/typedoc-deferred-promise-typedef
Sep 22, 2026
Merged

DmitrySharabin merged 1 commit into
v2from
fix/typedoc-deferred-promise-typedef

Conversation

@DmitrySharabin

Copy link
Copy Markdown
Member

TypeDoc cannot parse a type parameter on a @typedef name itself (DeferredPromise<T>); the generic has to come only from @template T. This broke TypeDoc for anyone building docs against this source, e.g. the website repo's npm run build:apidocs step.

Verified: cloning this branch instead of the default branch and running the website's typedoc build goes from 3 errors to 0.

Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com

TypeDoc cannot parse a type parameter on the @typedef name itself
(DeferredPromise<T>); the generic must come only from @template.
This broke the website's `npm run build:apidocs` step.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@netlify

netlify Bot commented Sep 22, 2026

Copy link
Copy Markdown

Deploy Preview for dev-prismjs-com ready!

Name Link
🔨 Latest commit 1b56dbc
🔍 Latest deploy log https://app.netlify.com/projects/dev-prismjs-com/deploys/6ab244cdec8494000869a3cc
😎 Deploy Preview https://deploy-preview-4125--dev-prismjs-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@DmitrySharabin
DmitrySharabin merged commit 91f552b into v2 Sep 22, 2026
12 checks passed
@DmitrySharabin
DmitrySharabin deleted the fix/typedoc-deferred-promise-typedef branch September 22, 2026 09:07
DmitrySharabin added a commit to PrismJS/website that referenced this pull request Sep 22, 2026
Picks up typedoc 0.28.20 and other patch/minor bumps. Needed to
retrigger the deploy preview now that PrismJS/prism#4125 (the
TypeDoc parse-error fix) has landed upstream.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
DmitrySharabin added a commit to PrismJS/website that referenced this pull request Sep 22, 2026
* Ditch the `prism-` prefix from the names of the files with examples

* Add `postinstall.mjs`

* Remove redundant dependencies in favor of the `postinstall` script

* Adjust 11ty settings accordingly

* Update `.gitignore`

* Fix the API docs URL

* Update scripts

- `examples.js`
- `theme-swithcher.js`

* Make the theme switcher work correctly

* Adjust the download page

* Update deps

* Improve plugin downloads

* Use the file highlight plugin

* Use another Prism source file for the showcase

* Adjust API docs generation

* Better handle plugin docs + generate `_redirects`

* Improve the postinstall script

* Update dependencies

Picks up typedoc 0.28.20 and other patch/minor bumps. Needed to
retrigger the deploy preview now that PrismJS/prism#4125 (the
TypeDoc parse-error fix) has landed upstream.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
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