browserChromium browser session with automatic cleanup via Explicit Resource Management. Usage: await using session = await op…Chromium browser session with automatic cleanup via Explicit Resource Management.
Usage: await using session = await openBrowser(); const png = await session.renderPage(html, 1200, 630); // browser.close() is called automatically when session goes out of scope
OgBrowserPool extends AsyncDisposableA set of independent sessions, closed together.A set of independent sessions, closed together.
AsyncDisposableexport interface OgBrowserPool extends AsyncDisposable| Name | Type | Description |
|---|---|---|
sessions |
OgBrowserSession[] |
OgBrowserSession extends AsyncDisposableA browser session that can render HTML pages to PNG. Implements AsyncDisposable…A browser session that can render HTML pages to PNG. Implements AsyncDisposable for automatic cleanup via await using.
AsyncDisposableexport interface OgBrowserSession extends AsyncDisposablerenderPage(html: string, width: number, height: number, publicDir?: string): Promise<Buffer>;htmlwidthheightpublicDir optionalPromise<Buffer>
openBrowser(): Promise<OgBrowserSession | null>Opens a Chromium browser and returns a session for rendering OG images. Returns…Opens a Chromium browser and returns a session for rendering OG images. Returns null if Playwright/Chromium is not available.
The session implements AsyncDisposable — use await using for automatic cleanup:
await using session = await openBrowser();
if (!session) return;
const png = await session.renderPage(html, 1200, 630);export async function openBrowser(): Promise<OgBrowserSession | null>Promise<OgBrowserSession | null>
openBrowserPool(size: number): Promise<OgBrowserPool | null>Opens up to size independent browsers. Rendering does not parallelize inside on…Opens up to size independent browsers.
Rendering does not parallelize inside one browser: every page shares a single connection to it, so eight pages in one browser finish no sooner than one does. Measured on 120 cards, milliseconds per image:
browsers 1 2 4 8 pages 1 84.6 — 25.6 14.7 pages 8 80.5 42.0 23.1 —
Pages buy nothing; browsers scale nearly linearly. Each one costs its own process, so this is bounded by the caller's concurrency, and concurrency: 1 keeps the old single-process footprint.
Returns null when Chromium cannot be launched at all. A launch that fails after the first still yields a working pool, one browser smaller.
export async function openBrowserPool(size: number): Promise<OgBrowserPool | null>size
number
Promise<OgBrowserPool | null>
PooledPageA pooled page and the public directory its route handler was set up for.A pooled page and the public directory its route handler was set up for.
interface PooledPage| Name | Type | Description |
|---|---|---|
page |
Page |
|
routedForoptional |
string |