Skip to content

lambda-api-gateway-streaming

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

lambda-api-gateway-streaming

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
package.json
package.json
 
 
serverless.yml
serverless.yml
 
 
tsconfig.json
tsconfig.json
 
 

README.md

API Gateway REST API + Response Streaming

This example demonstrates tRPC with Amazon API Gateway REST API response streaming, which allows you to stream response payloads back to clients progressively, improving time-to-first-byte (TTFB) and user experience.

This example must be deployed to AWS to work.

pnpm install
pnpm build
pnpm deploy

This will deploy the Lambda function and API Gateway REST API. The API Gateway endpoint URL will be displayed after deployment.

Server

The server is a tRPC server that uses awslambda.streamifyResponse() to enable Lambda response streaming. API Gateway is configured with responseTransferMode: STREAM to stream responses from Lambda to clients as they become available.

See the AWS blog post on API Gateway response streaming for more information about this capability.

Client

Replace https://???????.execute-api.us-east-1.amazonaws.com/dev in src/client.ts with the API Gateway endpoint URL from the deployment output.

pnpm start