@stream-mdx/worker

@stream-mdx/worker contains the worker runtime surface for StreamMDX: hosted worker assets, worker client helpers, Node worker_threads helpers, direct compile helpers, and MDX compile parity utilities.

Most browser app consumers will touch this package only indirectly through stream-mdx or @stream-mdx/react. Use it directly when you need explicit worker/runtime control.

Install

npm install @stream-mdx/worker

Exports

| Export | Purpose | | --- | --- | | @stream-mdx/worker | Main worker utilities surface | | @stream-mdx/worker/worker-client | Explicit worker client wiring | | @stream-mdx/worker/node | Node worker_threads hosted-worker helper | | @stream-mdx/worker/direct | Direct compile path without worker_threads | | @stream-mdx/worker/mdx-compile | Shared MDX compile helper | | @stream-mdx/worker/streaming/custom-matcher | Custom streaming matcher surface | | @stream-mdx/worker/hosted/markdown-worker.js | Hosted worker bundle asset |

Hosted Worker Bundle

Recommended production flow:

mkdir -p public/workers
cp node_modules/@stream-mdx/worker/dist/hosted/markdown-worker.js public/workers/markdown-worker.js

Then point the React surface at it:

<StreamingMarkdown worker="/workers/markdown-worker.js" />

This is the preferred deployment path for explicit CSP control and predictable static hosting.

Node worker_threads Helper

import { compileMarkdownSnapshot } from "@stream-mdx/worker/node";

const result = await compileMarkdownSnapshot({
  text: "# Hello\n\nCompiled in Node worker_threads.",
  init: {
    docPlugins: { tables: true, html: true, math: true, mdx: true, footnotes: true },
  },
});

Use this for SSR, static export, offline compilation, or TUI/CLI pipelines that want the same hosted worker behavior outside the browser.

Direct Compile Helper

import { compileMarkdownSnapshotDirect } from "@stream-mdx/worker/direct";

const result = await compileMarkdownSnapshotDirect({
  text: "# Hello\n\nDirect compile without worker_threads.",
  init: {
    docPlugins: { tables: true, html: true, math: true, mdx: true, footnotes: true },
  },
});

Use this in runtimes where worker_threads are unavailable or undesirable.

MDX Compile Parity Helper

import { compileMdxContent } from "@stream-mdx/worker/mdx-compile";

This is the shared MDX compilation path used to keep browser-worker and server compile flows aligned.

When To Reach For This Package

| Need | Use this package? | | --- | --- | | Host a static worker bundle in production | Yes | | Compile markdown snapshots in Node | Yes | | Build a custom worker integration | Yes | | Standard React app usage only | Usually no; use stream-mdx |

Documentation

• ../../docs/CLI_USAGE.md
• ../../docs/REACT_INTEGRATION_GUIDE.md
• ../../docs/SECURITY_MODEL.md
• ../../docs/STREAMING_MARKDOWN_PLUGINS_COOKBOOK.md