Skip to content

Commit

Permalink
fix: broaden renderMermaid browser type
Browse files Browse the repository at this point in the history
Allow passing either a Puppeteer Browser or a Puppeteer BrowserContext
to renderMermaid, as both work fine.
  • Loading branch information
aloisklink committed Oct 29, 2024
1 parent 35c779e commit 90f0bb2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ async function cli () {
/**
* Render a mermaid diagram.
*
* @param {import("puppeteer").Browser} browser - Puppeteer Browser
* @param {import("puppeteer").Browser | import("puppeteer").BrowserContext} browser - Puppeteer Browser
* @param {string} definition - Mermaid diagram definition
* @param {"svg" | "png" | "pdf"} outputFormat - Mermaid output format.
* @param {ParseMDDOptions} [opt] - Options, see {@link ParseMDDOptions} for details.
Expand Down

0 comments on commit 90f0bb2

Please sign in to comment.