How do you stream a large file or dataset as a response without loading it fully into memory in NestJS?

Q: How do you stream a large file or dataset as a response without loading it fully into memory in NestJS?

import { StreamableFile } from '@nestjs/common'; import { createReadStream } from 'fs'; import { join } from 'path'; // File download via streaming @Get(':id/export') async exportCsv( @Param('id', ParseIntPipe) id: number, @Res({ passthrough: true }) res: Response, ): Promise { const filePath = await this.exportService.generateCsv(id); const stream = createReadStream(filePath); res.setHeader('Content-Type', 'text/csv'); res.setHeader('Content-Disposition', `attachment; filename="export-${id}.csv"`); return new StreamableFile(stream); } // Streaming directly from a database cursor @Get('stream') async streamUsers( @Res({ passthrough: true }) res: Response, ): Promise { const cursor = await this.usersService.getCursor(); // returns Readable res.setHeader('Content-Type', 'application/json'); return new StreamableFile(cursor); } StreamableFile pipes the readable stream to the response without buffering the entire content. @Res({ passthrough: true }) sets headers while keeping NestJS's pipeline active — interceptors still run. Pass a Buffer or Readable stream to StreamableFile — it handles both. Set Content-Disposition: attachment to prompt a browser download instead of inline display. For large datasets use a database cursor or query stream instead of loading all records first.

Difficulty: 6/10

Streaming responses, NestJS Controllers, Back-pressure handling

Use StreamableFile from @nestjs/common to stream a Node.js Readable stream to the response. Combine with @Res({ passthrough: true }) to set Content-Type and Content-Disposition headers while still returning through NestJS's response pipeline. This avoids buffering the entire file in memory.

StreamableFile for file and data streaming

Streaming response best practices:

1
StreamableFile pipes the readable stream to the response without buffering the entire content.
2
@Res({ passthrough: true }) sets headers while keeping NestJS's pipeline active — interceptors still run.

How do you stream a large file or dataset as a response without loading it fully into memory in NestJS?

Difficulty: 6/10

Streaming responses, NestJS Controllers, Back-pressure handling

Use StreamableFile from @nestjs/common to stream a Node.js Readable stream to the response. Combine with @Res({ passthrough: true }) to set Content-Type and Content-Disposition headers while still returning through NestJS's response pipeline. This avoids buffering the entire file in memory.

StreamableFile for file and data streaming

Streaming response best practices:

1
StreamableFile pipes the readable stream to the response without buffering the entire content.
2
@Res({ passthrough: true }) sets headers while keeping NestJS's pipeline active — interceptors still run.

How do you stream a large file or dataset as a response without loading it fully into memory in NestJS?

Use StreamableFile from @nestjs/common to stream a Node.js Readable stream to the response. Combine with @Res({ passthrough: true }) to set Content-Type and Content-Disposition headers while still returning through NestJS's response pipeline. This avoids buffering the entire file in memory.

How do you stream a large file or dataset as a response without loading it fully into memory in NestJS?

Use StreamableFile from @nestjs/common to stream a Node.js Readable stream to the response. Combine with @Res({ passthrough: true }) to set Content-Type and Content-Disposition headers while still returning through NestJS's response pipeline. This avoids buffering the entire file in memory.

Scenario Questions

Follow-up Questions