@blazity/nest-file-fastify
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

fastify-multipart for Nest.js

Github Actions NPM NPM

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 @blazity/nest-file-fastify fastify-multipart

Yarn

$ yarn add @blazity/nest-file-fastify fastify-multipart

Docs

Single file

import { FileInterceptor, UploadedFile, StorageFile } from '@blazity/nest-file-fastify';

@Post('upload')
@UseInterceptors(FileInterceptor('file'))
uploadFile(@UploadedFile() file: StorageFile) {
  console.log(file);
}

FileInterceptor arguments:

  • fieldname: string - name of the field that holds a file

  • options: optional object of type UploadOptions

Array of files

import { FilesInterceptor, UploadedFiles, StorageFile } from '@blazity/nest-file-fastify';

@Post('upload')
@UseInterceptors(FilesInterceptor('files'))
uploadFile(@UploadedFiles() files: StorageFile[]) {
  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

Multiple files

import { FileFieldsInterceptor, UploadedFiles, StorageFile } from '@blazity/nest-file-fastify';

@Post('upload')
@UseInterceptors(FileFieldsInterceptor([
  { name: 'avatar', maxCount: 1 },
  { name: 'background', maxCount: 1 },
]))
uploadFile(@UploadedFiles() files: { avatar?: StorageFile[], background?: StorageFile[] }) {
  console.log(files);
}

FileFieldsInterceptor arguments:

Any files

import { AnyFilesInterceptor, UploadedFiles, StorageFile } from '@blazity/nest-file-fastify';

@Post('upload')
@UseInterceptors(AnyFilesInterceptor()
uploadFile(@UploadedFiles() files: StorageFile[]) {
  console.log(files);
}

AnyFilesInterceptor arguments:

Package Sidebar

Install

npm i @blazity/nest-file-fastify

Weekly Downloads

4,902

Version

1.0.0

License

MIT

Unpacked Size

54.5 kB

Total Files

83

Last publish

Collaborators

  • blazity-bmstefanski
  • xnerhu
  • xanewok
  • bemdev