Skip to content

976977577/nest-file-fastify

 
 

Repository files navigation

fastify-multipart for Nest.js

这个库为Nest.js添加了装饰器,以支持@fastify/multipart。其 API 与官方的 Nest.js Express 文件装饰器非常相似。

安装

NPM

$ npm install nest-file-fastify @fastify/multipart

Yarn

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

pnpm

$ pnpm install nest-file-fastify @fastify/multipart

并在您的 Nest.js 应用程序中注册 multipart 插件

import fastyfyMultipart from '@fastify/multipart';

...

app.register(fastyfyMultipart);

文档

单个文件

FileInterceptor 参数:

  • fieldname: string - 包含文件的字段的名称

  • options: 可选的 UploadOptions 类型对象

import { FileInterceptor, UploadedFile, MemoryStorageFile } from 'nest-file-fastify';

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

数组文件

FilesInterceptor 参数:

  • fieldname: string - 包含文件的字段的名称

  • maxCount: number - 可选的数字 - 接受的文件的最大数量

  • options: 可选的 UploadOptions 类型对象

import { FilesInterceptor, UploadedFiles, MemoryStorageFile } from 'nest-file-fastify';

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

多个文件

FileFieldsInterceptor 参数:

import { FileFieldsInterceptor, UploadedFiles, MemoryStorageFile } from '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);
}

任意文件

AnyFilesInterceptor 参数:

import { AnyFilesInterceptor, UploadedFiles, MemoryStorageFile } from 'nest-file-fastify';

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

About

Fastify-Multipart decorators for Nest.js

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%