Reference

Streaming API

The small surface area you need to build browser, Node.js, and server pipelines.

`ConvertBuddy.stream(input, options)`

Returns a controller immediately. Await controller.done for final immutable statistics.

const controller = new ConvertBuddy({ profile: true }).stream(input, options);
controller.pause();
controller.resume();
controller.cancel('reason');
const current = controller.stats();
const final = await controller.done;

Output callbacks

onBytes(chunk, stats): Exact emitted bytes. Preferred for file, network, and compression sinks. Async callbacks apply backpressure.
onData(text, stats): UTF-8 decoded output for text consumers and compatibility.
onRecords(controller, records, stats, total): Parsed record batches for ETL and application-level transforms.

`BuddyStats`

wallThroughputMbPerSec	End-to-end input MB/s, including awaited output writes.
recordsPerSec	Output records divided by end-to-end duration.
throughputMbPerSec	Engine-only throughput from parse/transform/write timings.
maxBufferSize	Peak bytes retained for an incomplete input record.
bytesIn / bytesOut	Exact input and output byte counts.
parseTimeMs / transformTimeMs / writeTimeMs	Profiled engine phase timings.

Inputs

Raw strings, Uint8Array, ArrayBuffer, Web ReadableStream, async iterables, and browser Blob/File objects are supported.