Async processing in plugins #185
Projects
Milestone
Comments
Closed
achingbrain
added a commit
to achingbrain/typedoc
that referenced
this issue
Dec 9, 2022
[5ddbbf6](TypeStrong@5ddbbf6) added a documentation note that says plugins can return a promise from their `load` function, but that promise needs to be awaited otherwise it'll resolve outside of the normal execution flow and can cause `unhandledPromiseRejection`s. The change here is to await the result of `initFunction`, which means making the `loadPlugins` function async and cascading that asynchronicity upwards. Also adds tests for loading sync/async and very slow plugins as I couldn't see where these were tested. Refs: TypeStrong#185
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hello,
A plugin I wrote process PlantUML diagrams in comments and generates links to images in the comments for those diagrams. The supporting libraries that do the image generation are async. Is there a way to tell TypeDoc to wait until the async processing in the plugin has completed before continuing? Or at least before reporting that document generation has completed? As it is now it works but TypeDoc reports that it is finished before the images have actually finished generating.
Thanks!
Meir
The text was updated successfully, but these errors were encountered: