# smms

> smms 图床插件

Latest version **1.0.7** (published 2017-10-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install smms
pnpm add smms
yarn add smms
bun add smms
```

## 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.7 |
| Published | 2017-10-25 |
| First published | 2017-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | 96qbhy |
| Maintainers | 96qbhy |
| Keywords | images, upload, free |

## Links

- npm: https://www.npmjs.com/package/smms
- npm.io page: https://npm.io/package/smms

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.17.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.0.7 (latest) — 2017-10-25
- 1.0.6 — 2017-10-25
- 1.0.5 — 2017-10-25
- 1.0.4 — 2017-10-24
- 1.0.3 — 2017-10-24
- 1.0.2 — 2017-10-24
- 1.0.1 — 2017-10-23

## README

# smms
[sm.ms](https://sm.ms) 图床上传插件

## 安装
```bash
npm install smms
```

## 使用
```javascript
// es6 
// import uploadImg from 'smms';
// require
const uploadImg = require('smms');
// file 应为 input[type=file] 拿到的 fileList 中的其中一个文件
uploadImg(file).then(data=>{
    // todo
});

// 在 jquery 中使用的例子
// html:  <input type="file" id="input">
const input = $('#input');

input.on('change', function (e) {
    if(e.target.files.length > 0){
        uploadImg(e.target.files[0]).then(data => {
            console.log(data);
        });
    }
});
```

## 返回数据说明
<table class="table table-bordered table-striped js-options-table">
    <thead>
        <tr>
            <th>名称</th>
            <th>类型</th>
            <th>示例值</th>
            <th>描述</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>code</td>
            <td>String</td>
            <td>success</td>
            <td>上传文件状态。正常情况为 <code>success</code>。出现错误时为 <code>error</code></td>
        </tr>
        <tr>
            <td>filename</td>
            <td>String</td>
            <td>smms.jpg</td>
            <td>上传文件时所用的文件名</td>
        </tr>
        <tr>
            <td>storename</td>
            <td>String</td>
            <td>561cc4e3631b1.png</td>
            <td>上传后的文件名</td>
        </tr>
        <tr>
            <td>size</td>
            <td>Int</td>
            <td>187851</td>
            <td>文件大小</td>
        </tr>
        <tr>
            <td>width</td>
            <td>Int</td>
            <td>1157</td>
            <td>图片的宽度</td>
        </tr>
        <tr>
            <td>height</td>
            <td>Int</td>
            <td>680</td>
            <td>图片的高度</td>
        </tr>
        <tr>
            <td>hash</td>
            <td>String</td>
            <td>nLbCw63NheaiJp1</td>
            <td>随机字符串，用于删除文件</td>
        </tr>
        <tr>
            <td>delete</td>
            <td>String</td>
            <td>https://sm.ms/api/delete/nLbCw63NheaiJp1</td>
            <td>删除上传的图片文件专有链接</td>
        </tr>
        <tr>
            <td>url</td>
            <td>String</td>
            <td>https://ooo.0o0.ooo/2015/10/13/561cfc3282a13.png</td>
            <td>图片服务器地址</td>
        </tr>
        <tr>
            <td>path</td>
            <td>String</td>
            <td>/2015/10/13/561cfc3282a13.png</td>
            <td>图片的相对地址</td>
        </tr>
        <tr>
            <td>msg</td>
            <td>String</td>
            <td>No files were uploaded.</td>
            <td>上传图片出错时将会出现</td>
        </tr>
    </tbody>
</table>

## 错误列表
 <table class="table table-bordered table-striped js-options-table" style="width: 400px;">
    <tr><td>Access Denied.</td></tr>
    <tr><td>Upload file count limit.</td></tr>
    <tr><td>Upload file frequency limit.</td></tr>
    <tr><td>Server error. Upload directory isn't writable.</td></tr>
    <tr><td>No files were uploaded.</td></tr>
    <tr><td>File is empty.</td></tr>
    <tr><td>File is too large.</td></tr>
    <tr><td>File has an invalid extension.</td></tr>
    <tr><td>Could not save uploaded file.</td></tr>
</table>

## 响应示例  
1. 成功示例  
```
{
    "code": "success",
    "data": {
        width: 1157,
        height: 680,
        filename: "image_2015-08-26_10-54-48.png",
        storename: "56249afa4e48b.png",
        size: 69525,
        path: "/2015/10/19/56249afa4e48b.png",
        hash: "nLbCw63NheaiJp1",
        timestamp: 1445239546,
        url: "https://ooo.0o0.ooo/2015/10/19/56249afa4e48b.png",
        delete: "https://sm.ms/api/delete/nLbCw63NheaiJp1"
    }
}
```
2. 失败示例  
```
{
    code: "error",
    msg: "No files were uploaded."
}
```

## 其他 API
1. 上传历史
```javascript
import {list} from 'smms';
list().then(({code,data})=>{
    console.log(data);    
})
```

2. 清除历史上传
```javascript
import {clear} from 'smms';
clear().then(({code,data})=>{
    console.log(data);    
})
```

3. 删除指定文件
```javascript
import {remove} from 'smms';
remove(hash).then(({code,data})=>{
    console.log(data);    
})
```
> 详细文档请移步 [https://sm.ms/doc/](https://sm.ms/doc/) 

## 感谢
感谢 sm.ms 提供的图床服务。
> sm.ms 并不是我的站点。

[https://github.com/96qbhy/smms](https://github.com/96qbhy/smms)  
96qbhy@gmail.com

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