Skip to content

Commit 566beff

Browse files
committed
docs(event-handler): add response streaming docs
1 parent 2fe04e3 commit 566beff

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
@@ -515,11 +515,31 @@ We plan to add first-class support for binary responses in a future release. Ple
515515

516516
### Response streaming
517517

518-
!!! note "Coming soon"
518+
!!! note "Compatibility"
519+
Response streaming is only available for [API Gateway REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/response-transfer-mode.html)
520+
and [Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html).
521+
522+
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.
523+
524+
In order to gain the most benefit, you should return either a readable [Nodejs stream](https://nodejs.org/api/stream.html#readable-streams),
525+
a duplex [Nodejs stream](https://nodejs.org/api/stream.html#class-streamduplex), or
526+
a [Web stream](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API#browser_compatibility) from your handlers. However, you can also return
527+
other types and these will also be delivered via HTTP streaming.
528+
529+
=== "index.ts"
530+
531+
```ts hl_lines="7 11"
532+
--8<-- "examples/snippets/event-handler/rest/advanced_response_streaming.ts:4"
533+
```
534+
535+
!!! tip "When to use streaming"
536+
Consider response streaming when:
519537

520-
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.
538+
- Returning large payloads (> 6MB)
539+
- Processing data that can be sent incrementally
540+
- Reducing time-to-first-byte for long-running operations is a requirement
521541

522-
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.
542+
For most use cases, the standard `resolve` method is sufficient.
523543

524544
### Debug mode
525545

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)