@mr687/nest-file-fastify
v1.1.1
Published
fastify-multipart decorators for Nest.js
Downloads
3
Maintainers
Readme
This library adds decorators for Nest.js to support @fastify/multipart. The API is very similar to the official Nest.js Express file decorators.
Installation
NPM
$ npm install @mr687/nest-file-fastify @fastify/multipart
Yarn
$ yarn add @mr687/nest-file-fastify @fastify/multipart
and register multpart plugin in your Nest.js application
import fastyfyMultipart from '@fastify/multipart';
...
app.register(fastyfyMultipart);
Docs
Single file
import { FileInterceptor, UploadedFile, MemoryStorageFile } from '@mr687/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 fileoptions
: optional object of typeUploadOptions
Array of files
import { FilesInterceptor, UploadedFiles, MemoryStorageFile } from '@mr687/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 filesmaxCount
: optional number - maximum number of files to acceptoptions
: optional object of typeUploadOptions
Multiple files
import { FileFieldsInterceptor, UploadedFiles, MemoryStorageFile } from '@mr687/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 typeUploadField
options
: optional object of typeUploadOptions
Any files
import { AnyFilesInterceptor, UploadedFiles, MemoryStorageFile } from '@mr687/nest-file-fastify';
@Post('upload')
@UseInterceptors(AnyFilesInterceptor()
uploadFile(@UploadedFiles() files: MemoryStorageFile[]) {
console.log(files);
}
AnyFilesInterceptor
arguments:
options
: optional object of typeUploadOptions