Repository navigation
docs(renderer): document closeBrowser() and fix the usage example - #28
Open
elwizard33 wants to merge 1 commit into
Open
elwizard33 wants to merge 1 commit into
elwizard33 wants to merge 1 commit into
Conversation
The shared headless browser stays open after a render, so a script using the renderer API never exits unless it calls closeBrowser(). Say so, and show it in the usage example. The example also imported bundle from @rendiv/renderer (it lives in @rendiv/bundler) and passed compositionId, which renderMedia does not accept; use selectComposition() and the composition option instead.
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 59 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
This branch has not been deployed
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
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.
Fixes #21.
Adds a short "Closing the browser" section to
docs/packages/renderer.md. It explains that the headless browser is shared between calls and that scripts need to callcloseBrowser()when they're done, otherwise Node doesn't exit.I also updated the usage example to match the current API. It now imports
bundlefrom@rendiv/bundlerrather than@rendiv/renderer, usesselectComposition()andcompositioninstead ofcompositionId, and callscloseBrowser()in afinally. The options table sayscompositionnow as well.One more thing I noticed but didn't change: the table says
concurrencydefaults to 4, butrenderFramesdefaults to 1. I wasn't sure which one is intended.