Installation

npm install uploadex
# or
yarn add uploadex

Quick Example (Single File)

// uploads.controller.ts
@Post('upload')
@UseInterceptors(UploadexInterceptor('file'))
upload(@UploadedFile() file: Express.Multer.File) {
  return this.uploadexService.handleSingleFileUpload(file);
}

Configuration (Using ConfigModule)

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { UploadsModule } from 'uploadex';

@Module({
  imports: [
    ConfigModule.forRoot({ isGlobal: true }),
    UploadsModule.registerAsync({
      imports: [ConfigModule],
      inject: [ConfigService],
      useFactory: (config: ConfigService) => ({
        provider: config.get<'s3' | 'azure' | 'gcs' | 'cloudinary' | 'local'>('UPLOAD_PROVIDER'),

        config: {
          bucket: config.get('S3_BUCKET') ?? '',
          region: config.get('S3_REGION') ?? '',
          accessKeyId: config.get('S3_ACCESS_KEY') ?? '',
          secretAccessKey: config.get('S3_SECRET') ?? '',
          endpoint: config.get('S3_ENDPOINT') ?? '', // For emulator or self-hosted S3
        },

        maxFileSize: parseInt(config.get('MAX_FILE_SIZE') ?? '10485760'),        // 10MB
        maxFiles: parseInt(config.get('MAX_FILES') ?? '5'),                      // Up to 5 files
        allowedMimeTypes: ['image/jpeg', 'image/png', 'application/pdf'],       // Accept only specific MIME types
        allowedExtensions: ['.jpg', '.jpeg', '.png', '.pdf'],                   // Restrict to safe extensions
        maxSafeMemorySize: parseInt(config.get('MAX_SAFE_MEMORY_SIZE') ?? '5242880'), // Buffer small files (5MB), stream large
        uploadRetries: parseInt(config.get('UPLOAD_RETRIES') ?? '2'),           // Retry twice on failure
        uploadTimeoutMs: parseInt(config.get('UPLOAD_TIMEOUT_MS') ?? '15000'),  // 15s timeout per upload
        debug: true,                                                             // Enable debug logs
      }),
    }),
  ],
  controllers: [UploadController],
  providers: [UploadService],
})
export class AppModule {}

Go Pro With the Full Docs

See the full documentation → https://www.uploadex.dev

Covers:

• Usage with all providers
• Emulator setups (LocalStack, Azurite, etc.)
• Streaming uploads and memory safety
• Configuring retries, timeouts, debug
• Managing env varibales && Error handling in depth
• Best practices for production

Official Examples

Looking for ready-to-use examples?

👉 Check out the full Uploadex Examples Repository Includes working setups for Local, S3, Azure, GCS, and Cloudinary — all pre-configured.

Author

Yassine El Idrissi — Portfolio
Creator of Uploadex, passionate about backend architecture and open source.

Support

If Uploadex saved you time — give it a ⭐ on GitHub
Tweet about it. Share it with friends. Help us grow the upload revolution.

License

MIT © 2025 Yassine El Idrissi