Framework Integration
- @nestjs/serve-static:
@nestjs/serve-staticis specifically designed for NestJS applications, making it a natural choice for projects built on this framework. It leverages NestJS's module system and dependency injection, ensuring a smooth integration. - express-static-gzip:
express-static-gzipis built for Express applications, providing a specialized solution for serving static files with Gzip compression. It can be easily integrated into any Express app, but it does not offer the framework-specific features that@nestjs/serve-staticprovides.
Gzip Compression
- @nestjs/serve-static:
@nestjs/serve-staticdoes not provide Gzip compression by default. However, you can enable Gzip compression in your NestJS application by using additional middleware, such ascompression, alongside@nestjs/serve-static. - express-static-gzip:
express-static-gzipautomatically handles Gzip compression for you. It serves files with Gzip compression if they are available, and it can also compress files on the fly if they are not pre-compressed. This feature makes it a more efficient choice for applications focused on optimizing bandwidth usage.
Pre-compressed File Support
- @nestjs/serve-static:
@nestjs/serve-staticdoes not support serving pre-compressed files out of the box. You would need to implement this functionality manually or use additional middleware to handle pre-compressed files. - express-static-gzip:
express-static-gzipsupports serving pre-compressed files (e.g., .gz files) natively. If a pre-compressed file is available, it will be served instead of the original file, which can significantly reduce load times for static assets.
Caching Control
- @nestjs/serve-static:
@nestjs/serve-staticallows you to set caching headers for static files, but you need to configure them manually. This gives you flexibility in how you manage caching, but it requires additional setup. - express-static-gzip:
express-static-gzipprovides built-in support for caching headers, and you can customize them easily. It also allows you to set cache control headers for both compressed and uncompressed files, making it more feature-rich in this regard.
Code Example
- @nestjs/serve-static:
Serving Static Files in NestJS
import { Module } from '@nestjs/common'; import { NestFactory } from '@nestjs/core'; import { AppModule } from './app.module'; import { ServeStaticModule } from '@nestjs/serve-static'; import { join } from 'path'; @Module({ imports: [ ServeStaticModule.forRoot([ { rootPath: join(__dirname, '..', 'public'), serveRoot: '/static', // Optional: Custom route prefix }, ]), ], }) class AppModule {} async function bootstrap() { const app = await NestFactory.create(AppModule); await app.listen(3000); } bootstrap(); - express-static-gzip:
Serving Static Files with Gzip in Express
const express = require('express'); const path = require('path'); const expressStaticGzip = require('express-static-gzip'); const app = express(); app.use('/static', expressStaticGzip(path.join(__dirname, 'public'), { enableBrotli: true, // Enable Brotli compression orderPreference: ['br', 'gzip'], // Prefer Brotli over Gzip })); app.listen(3000, () => { console.log('Server is running on http://localhost:3000'); });
