# fdfs

> FastDFS node client

Latest version **1.0.4** (published 2017-02-16) · ISC license · 0 weekly downloads

## Install

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

## 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.4 |
| Published | 2017-02-16 |
| First published | 2015-08-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 80 |
| Author | ymyang |
| Maintainers | ymyang |
| Keywords | FastDFS, fdfs, node |

## Links

- npm: https://www.npmjs.com/package/fdfs
- Repository: https://github.com/ymyang/fdfs
- Homepage: https://github.com/ymyang/fdfs#readme
- Issues: https://github.com/ymyang/fdfs/issues
- npm.io page: https://npm.io/package/fdfs

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.13.1
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.0
- [is-type-of](https://npm.io/package/is-type-of.md) ^1.0.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2017-02-16
- 1.0.3 — 2016-06-08
- 1.0.2 — 2016-06-08
- 1.0.1 — 2016-06-01
- 1.0.0 — 2016-05-31
- 0.9.1 — 2016-03-05
- 0.9.0 — 2016-03-05
- 0.8.1 — 2015-12-07
- 0.8.0 — 2015-12-05
- 0.7.2 — 2015-12-05
- 0.7.1 — 2015-12-05
- 0.7.0 — 2015-11-20
- 0.6.9 — 2015-11-10
- 0.6.8 — 2015-10-12
- 0.6.7 — 2015-10-12
- … 5 more at https://npm.io/package/fdfs/versions

## README

# Nodejs Client for FastDFS

[FastDFS](https://github.com/happyfish100/fastdfs) 是分布式文件存储系统。这个项目是FastDFS的NodeJS客户端，用来与FastDFS Server进行交互，进行文件的相关操作。我测试过的server版本是4.0.6。

# 安装

```shell

npm install fdfs

```

# 使用

```javascript

var FdfsClient = require('fdfs');

var fdfs = new FdfsClient({
    // tracker servers
    trackers: [
        {
            host: 'tracker.fastdfs.com',
            port: 22122
        }
    ],
    // 默认超时时间10s
    timeout: 10000,
    // 默认后缀
    // 当获取不到文件后缀时使用
    defaultExt: 'txt',
    // charset默认utf8
    charset: 'utf8'
});

```

以上是一些基本配置，你还可以自定义你的日志输出工具，默认是使用console
例如你要使用[debug](https://github.com/visionmedia/debug)作为你的日志输出工具，你可以这么做：

```javascript

var debug = require('debug')('fdfs');
var fdfs = new FdfsClient({
    // tracker servers
    trackers: [
        {
            host: 'tracker.fastdfs.com',
            port: 22122
        }
    ],
    logger: {
        log: debug
    }
});
```

### 上传文件

注：以下fileId为group + '/' + filename，以下的所有操作使用的fileId都是一样

通过本地文件名上传

```javascript

fdfs.upload('e:/shou.jpg').then(function(fileId) {
    // fileId 为 group + '/' + filename
    console.log(fileId);
}).catch(function(err) {
    console.error(err);
);

```

上传Buffer

```javascript

var fs = require('fs');

// 注意此处的buffer获取方式只为演示功能，实际不会这么去构建buffer
var buffer = fs.readFileSync('test.gif');
fdfs.upload(buffer).then(function(fileId) {
    // fileId 为 group + '/' + filename
    console.log(fileId);
}).catch(function(err) {
    console.error(err);
);

```

ReadableStream

```javascript

var fs = require('fs');

var rs = fs.createReadStream('test.gif');
fdfs.upload(rs).then(function(fileId) {
    // fileId 为 group + '/' + filename
    console.log(fileId);
}).catch(function(err) {
    console.error(err);
);

```

其他一些options，作为第2个参数传入

```js

fdfs.upload('test.gif', {
    // 上传方法 [upload, uploadAppender, append, modify], 默认为upload
    method: 'upload',
    // 指定文件存储的group，不指定则由tracker server分配
    group: 'group1',
    // method为append或modify指定追加的源文件
    fileId: 'group1/M00/00/0F/wKgBeFXlZJuAdsBZAAPm5H9JxDA153.jpg',
    // file bytes, file参数为ReadableStream时必须指定
    size: 1024,
    // method为modify指定追加的源文件的起始点
    offset: 10240,
    // 上传文件的后缀，不指定则获取file参数的后缀，不含(.)
    ext: 'jpg'
}).then(function(fileId) {
    // fileId 为 group + '/' + filename
    console.log(fileId);
}).catch(function(err) {
    console.error(err);
);
 
```

### 下载文件

下载到本地

```js

fdfs.download(fileId, 'test_download.gif').then(function() {
    // 下载完成
    
}).catch(function(err) {
    console.error(err);
);

```

下载到WritableStream

```js

var fs = require('fs');
var ws = fs.createWritableStream('test_download.gif');
fdfs.download(fileId, ws).then(function() {
    // 下载完成
    
}).catch(function(err) {
    console.error(err);
);

```

下载文件片段

```js

fdfs.download(fileId, {
    target: 'test_download.part',
    offset: 5,
    bytes: 5
}).then(function() {
    // 下载完成
    
}).catch(function(err) {
    console.error(err);
);

```

### 删除文件

```js

fdfs.del(fileId).then(function() {
    // 删除成功
    
}).catch(function(err) {
    console.error(err);
);

```

### 获取文件信息

```js

fdfs.getFileInfo(fileId).then(function(fileInfo) {
    // fileInfo有4个属性
    // {
    //   // 文件大小
    //   size:
    //   // 文件创建的时间戳，单位为秒
    //   timestamp:
    //   // 校验和
    //   crc32:
    //   // 最初上传到的storage server的ip
    //   addr:
    // }
    console.log(fileInfo);
}).catch(function(err) {
    console.error(err);
);

```

### 文件的Meta Data

设置Meta Data, 我只贴出来文件签名信息吧，flag字段如果不传则默认是O

```js

/**
 * @param fileId
 * @param metaData  {key1: value1, key2: value2}
 * @param flag 'O' for overwrite all old metadata (default)
                'M' for merge, insert when the meta item not exist, otherwise update it
 */
fdfs.setMetaData(fileId, metaData, flag).then(function() {
    // 设置成功
    
}).catch(function(err) {
    console.error(err);
); 

```

获取Meta Data

```js

fdfs.getMetaData(fileId).then(function(metaData) {
    console.log(metaData);
}).catch(function(err) {
    console.error(err);
);

```

### group信息

```js

fdfs.listGroups().then(function(groups) {
    console.log(groups);
}).catch(function(err) {
    console.error(err);
); 

```

### storage信息

```js

fdfs.listStorages(‘group1’).then(function(storages) {
    console.log(storages);
}).catch(function(err) {
    console.error(err);
); 

```

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