# egg-oss-d

> ``` $ npm i egg-oss ``` To enable oss plugin, you should change ${baseDir}/config/plugin.js

Latest version **1.0.0** (published 2021-12-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install egg-oss-d
pnpm add egg-oss-d
yarn add egg-oss-d
bun add egg-oss-d
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-12-29 |
| First published | 2021-12-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | wild_dudu |

## Links

- npm: https://www.npmjs.com/package/egg-oss-d
- npm.io page: https://npm.io/package/egg-oss-d

## Recent versions

- 1.0.0 (latest) — 2021-12-29

## README

## egg-oss

### Install

```
$ npm i egg-oss
```
To enable oss plugin, you should change ${baseDir}/config/plugin.js

```
// config/plugin.js
exports.oss = {
  enable: true,
  package: 'egg-oss',
};
```

Then fill in nessary information like OSS's bucket, accessKeyId, accessKeySecret in ${baseDir}/config/config.{env}.js

```
//config/config.default.js
exports.oss = {
  client: {
    accessKeyId: 'your access key',
    accessKeySecret: 'your access secret',
    bucket: 'your bucket name',
    endpoint: 'oss-cn-hongkong.aliyun.com',
    timeout: '60s',
  },
};
//file
exports.multipart = {  
  mode: 'file',
};
```

### Usage

You can aquire oss instance on app or ctx.

The example below will upload file to oss using the file mode of egg-multipart.

```
const path = require('path');
const Controller = require('egg').Controller;
const fs = require('fs');
 
// upload a file in controller

module.exports = class extends Controller {
  async upload() {
    const ctx = this.ctx;
    const file = ctx.request.files[0];
    const name = 'egg-oss-demo/' + new Date().getTime()+ path.basename(file.filename);
    let result;
    try {
      result = await ctx.oss.put(name, file.filepath);
    } finally {
      await fs.unlinkSync(file.filepath);
    }
 
    if (result) {
       ctx.body={
         code:1,
         url:result.url,
         msg:'成功'
       }
    } else {
       ctx.body={
        code:0,
        msg:'失败'
      }
    }
  }
};
```

### vue 

```
npx cnpm i element-ui -D
```

```
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
Vue.use(ElementUI);
```

```
action="/api/upload"


handleAvatarSuccess(res, file) {
        this.imageUrl = res.url
      },
```

---
_Source: https://npm.io/package/egg-oss-d · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._