# candyjs-uploader

**Repository Path**: candyjs/candyjs-uploader

## Basic Information

- **Project Name**: candyjs-uploader
- **Description**: 用于 candyjs 的文件上传扩展
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-19
- **Last Updated**: 2022-05-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## candyjs 文件上传组件

此组件基于 formidable 开发，旨在为 candyjs 提供文件上传功能

## 使用

#### 安装

```
npm install @candyjs/uploader
```

#### 直接使用

```
const Uploader = require('@candyjs/uploader');

module.exports = class UploadController {
    async run(req, res) {
        const up = new Uploader({
            // 必须参数 相对于入口脚本的路径
            basePath: './public/upload',

            // 可选参数
            allowTypes: 'image/jpg, image/jpeg, image/png',
            maxSize: 1048576,  // 1024 * 1024 = 1Mb
        });

        let data = await up.upload(req, 'myfile');
        res.end(JSON.stringify(data));
    }
}
```

#### 指定文件名

```
const Uploader = require('@candyjs/uploader');

module.exports = class UploadController {
    async run(req, res) {
        const up = new Uploader({
            // 必须参数
            basePath: './public/upload',

            // 使用指定的文件名 而非随机名字
            givenName: 'abc'
        });

        let data = await up.upload(req, 'editorfile');
        res.end(JSON.stringify(data));
    }
}
```

## CHANGELOG

+ 2020-10-30

    * 0.1.2 优化代码

+ 2020-10-24

    * 0.1.0 节日快乐 提交插件