Documentation Index
Fetch the complete documentation index at: https://mintlify.com/Pratyay360/podman-ts/llms.txt
Use this file to discover all available pages before exploring further.
podman-ts models streaming responses as async iterables, letting you process data incrementally as it arrives rather than waiting for a complete response. Two parts of the SDK support streaming out of the box: container logs and system events. For custom pipelines, the library also exports lineStream and jsonStream helper generators.
Streaming relies on Bun-native APIs. Run your application with Bun (bun >= 1.0). Streaming container logs
Call container.logs() with { stream: true } to receive an AsyncIterable<string> instead of a single concatenated string. Add follow: true to keep the stream open and receive new log lines as the container writes them.
import { PodmanClient } from "@pratyay360/podman-ts";
const client = new PodmanClient();
const container = await client.containers.get("my-container");
const logStream = await container.logs({ stream: true, follow: true });
for await (const chunk of logStream) {
process.stdout.write(chunk + "\n");
}
stream: true, container.logs() resolves to a plain string containing the full log output collected up to that point.
Streaming events
client.events.list() is an async generator over the Podman /events endpoint. Set decode: true to receive parsed objects instead of raw JSON strings:
for await (const line of client.events.list({ decode: true })) {
const event = line as Record<string, unknown>;
console.log(event["Type"], event["Action"]);
}
since, until, and filters:
for await (const line of client.events.list({
decode: true,
filters: { type: "container" },
})) {
const event = line as Record<string, unknown>;
console.log(event);
}
stream() method — list() is always a generator.
jsonStream and lineStream helpers
Both helpers are exported from @pratyay360/podman-ts and operate on any AsyncIterable<string> or Iterable<string>. Use them when you need to build a custom streaming pipeline on top of client.api or any other source that yields text chunks.
lineStream
import { lineStream } from "@pratyay360/podman-ts";
async function* lineStream(stream: AsyncIterable<string>): AsyncGenerator<string>
import { lineStream } from "@pratyay360/podman-ts";
// rawStream is any AsyncIterable<string>
for await (const line of lineStream(rawStream)) {
console.log(line);
}
jsonStream
import { jsonStream } from "@pratyay360/podman-ts";
async function* jsonStream(
stream: AsyncIterable<string> | Iterable<string>,
): AsyncGenerator<unknown>
StreamParseError.
import { jsonStream } from "@pratyay360/podman-ts";
for await (const obj of jsonStream(rawStream)) {
console.log(obj);
}
jsonStream accepts both sync (Iterable<string>) and async (AsyncIterable<string>) sources, making it usable in tests with plain arrays as well as in production with live HTTP response bodies.
Stopping a stream
Use the timeout option on PodmanClient to apply a global request timeout, or use an AbortController if you need programmatic control:
const client = new PodmanClient({ timeout: 30_000 }); // 30 s hard limit
// Break early from the loop to stop consuming the stream
for await (const line of client.events.list({ decode: true })) {
const event = line as Record<string, unknown>;
if (event["Action"] === "die") {
break; // stop iterating; the generator is abandoned
}
}
Breaking out of a for await...of loop causes the generator to stop yielding, but the underlying HTTP connection may remain open until the server closes it or the process exits. For long-lived programs, prefer a bounded until timestamp on client.events.list() to let the server close the stream naturally.
