Skip to content

Commit 96e9b3f

Browse files
committed
docs(event-handler): add response streaming docs
1 parent dd9b722 commit 96e9b3f

File tree

2 files changed

+43
-3
lines changed

2 files changed

+43
-3
lines changed

docs/features/event-handler/rest.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -544,11 +544,31 @@ We plan to add first-class support for binary responses in a future release. Ple
544544

545545
### Response streaming
546546

547-
!!! note "Coming soon"
547+
!!! note "Compatibility"
548+
Response streaming is only available for [API Gateway REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/response-transfer-mode.html)
549+
and [Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html).
550+
551+
You can send responses to the client using HTTP streaming by wrapping your router with the `streamify` function to turn all the associated route handlers into stream compatible handlers. This is useful when you need to send large payloads or want to start sending data before the entire response is ready.
552+
553+
In order to gain the most benefit, you should return either a readable [Nodejs stream](https://nodejs.org/api/stream.html#readable-streams),
554+
a duplex [Nodejs stream](https://nodejs.org/api/stream.html#class-streamduplex), or
555+
a [Web stream](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API#browser_compatibility) from your handlers. However, you can also return
556+
other types and these will also be delivered via HTTP streaming.
557+
558+
=== "index.ts"
559+
560+
```ts hl_lines="7 11"
561+
--8<-- "examples/snippets/event-handler/rest/advanced_response_streaming.ts:4"
562+
```
563+
564+
!!! tip "When to use streaming"
565+
Consider response streaming when:
548566

549-
At the moment, Event Handler does not support streaming responses. This means that the entire response must be generated and returned by the route handler before it can be sent to the client.
567+
- Returning large payloads (> 6MB)
568+
- Processing data that can be sent incrementally
569+
- Reducing time-to-first-byte for long-running operations is a requirement
550570

551-
Please [check this issue](https://github.com/aws-powertools/powertools-lambda-typescript/issues/4476) for more details and add 👍 if you would like us to prioritize it.
571+
For most use cases, the standard `resolve` method is sufficient.
552572

553573
### Debug mode
554574

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
declare function createVideoStream(): Readable;
2+
3+
import type { Readable } from 'node:stream';
4+
import {
5+
Router,
6+
streamify,
7+
} from '@aws-lambda-powertools/event-handler/experimental-rest';
8+
9+
const app = new Router();
10+
11+
app.get('/video-stream', async (reqCtx) => {
12+
reqCtx.res.headers.set('content-type', 'video/mp4');
13+
return createVideoStream();
14+
});
15+
16+
app.get('/hello', () => {
17+
return { message: 'Hello World' };
18+
});
19+
20+
export const handler = streamify(app);

0 commit comments

Comments
 (0)