{"id":23290788,"url":"https://github.com/quicksend/nestjs-transmit","last_synced_at":"2026-05-10T03:54:50.124Z","repository":{"id":57138576,"uuid":"350906537","full_name":"quicksend/nestjs-transmit","owner":"quicksend","description":"Integrate Transmit into your NestJS applications.","archived":false,"fork":false,"pushed_at":"2023-03-08T03:31:06.000Z","size":651,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-03T02:47:13.792Z","etag":null,"topics":["form","form-data","formdata","multipart","nest","nestjs","nodejs","typescript","upload"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quicksend.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-24T01:15:02.000Z","updated_at":"2021-07-16T21:39:18.000Z","dependencies_parsed_at":"2024-10-30T09:32:17.546Z","dependency_job_id":null,"html_url":"https://github.com/quicksend/nestjs-transmit","commit_stats":{"total_commits":9,"total_committers":1,"mean_commits":9.0,"dds":0.0,"last_synced_commit":"9cb3390bcdabce78bd1db70be5aed8b4a7f2269f"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quicksend%2Fnestjs-transmit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quicksend%2Fnestjs-transmit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quicksend%2Fnestjs-transmit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quicksend%2Fnestjs-transmit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quicksend","download_url":"https://codeload.github.com/quicksend/nestjs-transmit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247526675,"owners_count":20953141,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["form","form-data","formdata","multipart","nest","nestjs","nodejs","typescript","upload"],"created_at":"2024-12-20T05:12:08.911Z","updated_at":"2026-05-10T03:54:50.063Z","avatar_url":"https://github.com/quicksend.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NestJS Transmit\n\nIntegrate [Transmit](https://github.com/quicksend/transmit) into your NestJS applications.\n\n## Installation\n\n```bash\n$ npm install @quicksend/nestjs-transmit @quicksend/transmit\n```\n\n## Usage\n\n### TransmitModule\nFirst start by registering the `TransmitModule` in your application:\n\n```ts\nimport { Module } from \"@nestjs/core\";\nimport { TransmitModule } from \"@quicksend/nestjs-transmit\";\n\n@Module({\n  imports: [\n    TransmitModule.register()\n  ]\n})\nexport class FilesModule {}\n```\n\nYou can optionally configure Transmit by passing in [TransmitOptions](https://quicksend.github.io/transmit/interfaces/transmitoptions.html) while registering the module:\n\n```ts\nimport { Module } from \"@nestjs/core\";\nimport { TransmitModule } from \"@quicksend/nestjs-transmit\";\n\n@Module({\n  imports: [\n    TransmitModule.register({\n      maxFiles: 5,\n      maxFileSize: 100 * 1024 * 1024,\n    })\n  ]\n})\nexport class FilesModule {}\n```\n\n`TransmitModule` can also be registered asynchronously like so:\n\n```ts\nimport { ConfigModule, ConfigService } from \"@nestjs/config\";\nimport { Module } from \"@nestjs/core\";\nimport { TransmitModule } from \"@quicksend/nestjs-transmit\";\n\n@Module({\n  imports: [\n    TransmitModule.registerAsync({\n      imports: [ConfigModule],\n      inject: [ConfigService],\n      useFactory: (config: ConfigService) =\u003e ({\n        maxFiles: config.get(\"MAX_FILES\"),\n        maxFileSize: config.get('MAX_FILE_SIZE'),\n      })\n    })\n  ]\n})\nexport class FilesModule {}\n```\n\n### TransmitInterceptor\n\nOnce `TransmitModule` is registered, you can now use `TransmitInterceptor` in your controller to handle file uploads.\n\nYou can use the `Fields` and `Files` decorator to retrieve the fields and files that were received.\n\n```ts\nimport { Controller, Post, UseInterceptors } from \"@nestjs/common\";\n\nimport { Field, File, ParseAsyncResults } from \"@quicksend/transmit\";\n\nimport { Fields, Files, TransmitInterceptor } from \"@quicksend/nestjs-transmit\";\n\n@Controller()\nexport class FilesController {\n  @Post(\"upload\")\n  @UseInterceptors(TransmitInterceptor())\n  upload(@Fields() fields: Field[], @Files() files: File[]): ParseAsyncResults {\n    return {\n      fields,\n      files\n    };\n  }\n}\n```\n\nYou can also pass in [TransmitOptions](https://quicksend.github.io/transmit/interfaces/transmitoptions.html) when using `TransmitInterceptor`. This will allow you to override certain options for a specific endpoint or endpoints.\n\n```ts\nimport { Controller, Post, UseInterceptors } from \"@nestjs/common\";\n\nimport { Field, File, ParseAsyncResults } from \"@quicksend/transmit\";\n\nimport { Fields, Files, TransmitInterceptor } from \"@quicksend/nestjs-transmit\";\n\n@Controller()\nexport class FilesController {\n  @Post(\"upload\")\n  @UseInterceptors(\n    TransmitInterceptor({\n      maxFiles: 2,\n      maxFileSize: 25 * 1024 * 1024,\n    })\n  )\n  upload(@Fields() fields: Field[], @Files() files: File[]): ParseAsyncResults {\n    return {\n      fields,\n      files\n    };\n  }\n}\n```\n\n## Tests\n\nRun tests using the following commands:\n```bash\n$ npm run test\n$ npm run test:watch\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquicksend%2Fnestjs-transmit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquicksend%2Fnestjs-transmit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquicksend%2Fnestjs-transmit/lists"}