Comparing changes

## Summary by CodeRabbit * **Documentation** * Updated documentation comments for improved clarity.

…eturn value (#1535) ## Summary Adds **partial** support for returning a `ReadableStream<Uint8Array>` directly from an oRPC handler (OpenAPIHandler only), bypassing JSON serialization. This enables streaming binary responses (ZIP archives, large file downloads, chunked transfer) without buffering the full response in memory. > **Note:** Full ecosystem support (RPCHandler/Link, OpenAPILink, WebSocket adapters, etc.) is planned for v2 — see [#1058](#1058 (comment)). This PR intentionally does **not** close #1058. ### Stream passthrough - **`@orpc/standard-server`** — adds `ReadableStream<Uint8Array>` to the `StandardBody` union type - **`@orpc/server`** — `StandardRPCCodec.encode()` detects `ReadableStream` and passes it through without serializing - **`@orpc/openapi`** — `StandardOpenAPICodec.encode()` detects `ReadableStream` (both as direct return and inside `{ body: stream, headers }` detailed output), respects the contract's `successStatus`, and bypasses serialization - **`@orpc/standard-server-fetch`** — `toFetchBody()` returns the stream directly; the `ReadableStream` branch runs before header cleanup so caller-set `content-type`/`content-disposition` are preserved - **`@orpc/standard-server-node`** — `toNodeHttpBody()` converts via `Readable.fromWeb()`; same header-preservation fix - **`@orpc/standard-server`** — `generateContentDisposition()` gets an optional `disposition` parameter (defaults to `'inline'`, fully backward-compatible) ### OpenAPI spec cleanup (fixes #1536) - **`@orpc/openapi`** — `separateObjectSchema` no longer leaves empty `properties: {}` / `required: []` on extracted schemas (replaces them with `undefined`) - **`@orpc/openapi`** — new `isNeverSchema()` helper identifies `false` / `{ not: true }` / `{ not: {} }` schemas; `toOpenAPIContent()` now skips the spurious `application/json: { schema: { not: {} } }` entry that used to appear alongside binary content (e.g. when using `oz.openapi(z.instanceof(ReadableStream), { contentMediaType: 'application/zip' })`) - **`@orpc/openapi`** — generator skips emitting an empty `requestBody` for POST routes whose input consists only of path parameters Tests added for all new paths including header preservation, detailed-output streaming, never-schema detection, and the empty-requestBody case. ## Backward compatibility This is a non-breaking change. - Previously, returning a `ReadableStream` from a handler would result in it being serialized as `{}` (or a runtime error), which is not useful behaviour anyone would rely on. - `generateContentDisposition()`'s new `disposition` parameter defaults to `'inline'`, preserving existing output. - The OpenAPI spec cleanups only suppress output that was previously noise (empty bodies, `not: {}` alongside real content). Existing handlers and generated specs are unaffected. ## Motivation We are migrating a service from Hapi.js to Hono + oRPC. One endpoint streams a ZIP archive on-the-fly using `archiver` — the archive must be piped directly to the response. All existing workarounds (returning `new Response(stream)`, `oz.blob()`, casting) either fail at runtime or require bypassing oRPC entirely, losing auth middleware and client-library support. Relates to #1058 (partial — OpenAPIHandler only) Closes #1536 ## Test plan - [ ] `pnpm --filter @orpc/standard-server test` - [ ] `pnpm --filter @orpc/server test` - [ ] `pnpm --filter @orpc/openapi test` - [ ] `pnpm --filter @orpc/standard-server-fetch test` - [ ] `pnpm --filter @orpc/standard-server-node test` 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 4.6 <[email protected]> Co-authored-by: Dinh Le <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comparing changes

Open a pull request

Commits on Apr 11, 2026

Commits on Apr 17, 2026

Commits on Apr 22, 2026

This comparison is taking too long to generate.

Uh oh!