Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blazity/nest-file-fastify
Fastify-Multipart decorators for Nest.js
https://github.com/blazity/nest-file-fastify
fastify fastify-multipart file multipart nest nestjs upload
Last synced: about 2 months ago
JSON representation
Fastify-Multipart decorators for Nest.js
- Host: GitHub
- URL: https://github.com/blazity/nest-file-fastify
- Owner: Blazity
- Created: 2021-10-01T09:21:43.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T02:19:10.000Z (about 1 year ago)
- Last Synced: 2024-04-22T13:54:17.506Z (8 months ago)
- Topics: fastify, fastify-multipart, file, multipart, nest, nestjs, upload
- Language: TypeScript
- Homepage: https://blazity.com/
- Size: 82 KB
- Stars: 40
- Watchers: 3
- Forks: 19
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
fastify-multipart for Nest.js
[](https://github.com/Blazity/nest-file-fastify)
[](https://www.npmjs.com/package/@blazity/nest-file-fastify)
[](https://www.npmjs.com/package/@blazity/nest-file-fastify)
This library adds decorators for [Nest.js](https://github.com/nestjs/nest) to support [@fastify/multipart](https://github.com/fastify/fastify-multipart). The API is very similar to the official Nest.js Express file decorators.
## Installation
NPM
```bash
$ npm install @blazity/nest-file-fastify @fastify/multipart
```
Yarn
```bash
$ yarn add @blazity/nest-file-fastify @fastify/multipart
```
and register multpart plugin in your Nest.js application
```typescript
import fastyfyMultipart from '@fastify/multipart';
...
app.register(fastyfyMultipart);
```
## Docs
### Single file
```ts
import { FileInterceptor, UploadedFile, MemoryStorageFile } from '@blazity/nest-file-fastify';
@Post('upload')
@UseInterceptors(FileInterceptor('file'))
uploadFile(@UploadedFile() file: MemoryStorageFile) {
console.log(file);
}
```
`FileInterceptor` arguments:
- `fieldname`: string - name of the field that holds a file
- `options`: optional object of type [`UploadOptions`](src/multipart/options.ts#L4)
### Array of files
```ts
import { FilesInterceptor, UploadedFiles, MemoryStorageFile } from '@blazity/nest-file-fastify';
@Post('upload')
@UseInterceptors(FilesInterceptor('files'))
uploadFile(@UploadedFiles() files: MemoryStorageFile[]) {
console.log(files);
}
```
`FilesInterceptor` arguments:
- `fieldname`: string - name of the field that holds files
- `maxCount`: optional number - maximum number of files to accept
- `options`: optional object of type [`UploadOptions`](src/multipart/options.ts#L4)
### Multiple files
```ts
import { FileFieldsInterceptor, UploadedFiles, MemoryStorageFile } from '@blazity/nest-file-fastify';
@Post('upload')
@UseInterceptors(FileFieldsInterceptor([
{ name: 'avatar', maxCount: 1 },
{ name: 'background', maxCount: 1 },
]))
uploadFile(@UploadedFiles() files: { avatar?: MemoryStorageFile[], background?: MemoryStorageFile[] }) {
console.log(files);
}
```
`FileFieldsInterceptor` arguments:
- `uploadFields`: object of type [`UploadField`](src/multipart/handlers/file-fields.ts#L10)
- `options`: optional object of type [`UploadOptions`](src/multipart/options.ts#L4)
### Any files
```ts
import { AnyFilesInterceptor, UploadedFiles, MemoryStorageFile } from '@blazity/nest-file-fastify';
@Post('upload')
@UseInterceptors(AnyFilesInterceptor()
uploadFile(@UploadedFiles() files: MemoryStorageFile[]) {
console.log(files);
}
```
`AnyFilesInterceptor` arguments:
- `options`: optional object of type [`UploadOptions`](src/multipart/options.ts#L4)