# @cloudcmd/dropbox 中文文档

规范地址：https://npmcn.com/package/%40cloudcmd/dropbox/

版本：5\.0\.3
npm 元数据更新时间：2024-03-16T16:41:18.562Z
中文译文更新时间：2026-11-10T09:30:29.640Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cloudcmd/dropbox
原文对照：https://npmcn.com/package/%40cloudcmd/dropbox/?lang=original
项目主页：http://github.com/cloudcmd/dropbox
源码仓库：https://github.com/cloudcmd/dropbox

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：14.3 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=18
- 运行依赖：6 个
- 首次发布：2018-02-08T14:23:37.319Z
- 最新版本发布：2024-03-16T16:41:18.096Z
- 近 30 天下载量：1825（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 0 个）

## 中文简介

收发箱文件和文件夹 crud

## 安装

```sh
npm install @cloudcmd/dropbox
```

也可以使用：`pnpm add @cloudcmd/dropbox`、`yarn add @cloudcmd/dropbox`、`bun add @cloudcmd/dropbox`

## README

# 弹出框 [![License](https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat)](https://tldrlegal.com/license/mit-license "MIT License") [![NPM version](https://img.shields.io/npm/v/@cloudcmd/dropbox.svg?style=flat)](https://npmjs.org/package/@cloudcmd/dropbox "npm") [![Build Status](https://github.com/cloudcmd/dropbox/workflows/Node%20CI/badge.svg)](https://github.com/cloudcmd/dropbox/actions?query=workflow%3A%22Node+CI%22 "Build Status") [![Coverage Status](https://coveralls.io/repos/cloudcmd/dropbox/badge.svg?branch=master&service=github)](https://coveralls.io/github/cloudcmd/dropbox?branch=master)

Dropbox 文件和文件夹 CRUD.

## 安装

```
npm i @cloudcmd/dropbox --save
```

## API 密码

所有职能都要求 [符号](https://blogs.dropbox.com/developers/2014/05/generate-an-access-token-for-your-own-account/) 作为第一个参数

### 已读 Dir( token, 路径\[, 选项\])

-   **符号** - 说吧 `string`
-   **路径** - 说吧 `string`
-   **选项** - 说吧 `object` 可包含:
    -   `sort` - 按名称、大小、日期排序
    -   `order` - “asc”或“desc”用于升降顺序(默认:“asc”)
    -   `type` - 当“ raw” 返回而不是格式化结果时

#### 示例

```js
const sort = 'size';
const order = 'desc';
const token = 'token';
const path = '/';
const type = 'raw';

const {readDir} = require('@cloudcmd/dropbox');

const files = await readDir(token, path, {
    type,
    sort,
    order,
});

console.log(files);
// outputs
({
    path: '/',
    files: [{
        name: 'dropbox.js',
        size: 4735,
        date: 1_377_248_899_000,
        owner: 0,
        mode: 0,
    }, {
        name: 'readify.js',
        size: 3735,
        date: 1_377_248_899_000,
        owner: 0,
        mode: 0,
    }],
});
```

### 读取文件( 已打开, 路径)

-   **符号** - 说吧 `token`
-   **路径** - 文件路径

#### 示例

```js
const {readFile} = require('@cloudcmd/dropbox');

const readStream = await readFile(token, '/dropbox.html');
readStream.pipe(process.stdout);
```

### 写入文件( ken, 路径, 内容)

-   **符号** - 说吧 `token`
-   **路径** - 文件路径
-   **目录** - 文件的内容

#### 示例

```js
const {writeFile} = require('@cloudcmd/dropbox');

await writeFile(token, '/hello.txt', 'hello');
```

### 创建WriteStream( 脚本, 路径)

-   **符号** - 说吧 `token`
-   **路径** - 文件路径

#### 示例

```js
const {createReadStream} = require('fs');
const {createWriteStream} = require('@cloudcmd/dropbox');

const token = 'token';
const path = '/file';

const dropboxStream = createWriteStream(token, path);
const localStream = createReadStream(path);

localStream
    .pipe(dropboxStream)
    .on('error', console
        .error)
    .on('finish', console.log);
```

### 创建ReadStream(已打开, 路径)

-   **符号** - 说吧 `token`
-   **路径** - 文件路径

#### 示例

```js
const {createWriteStream} = require('fs');
const {createReadStream} = require('@cloudcmd/dropbox');

const token = 'token';
const path = '/file';

const dropboxStream = createReadStream(path);
const localStream = createWriteStream(token, path);

dropboxStream
    .pipe(localStream)
    .on('error', console
        .error)
    .on('finish', console.log);
```

### 删除( token, 路径)

删除文件/目录 .

-   **符号** - 说吧 `token`
-   **路径** - 文件路径

#### 示例

```js
const {remove} = require('@cloudcmd/dropbox');

await remove(token, '/fileOrDir');
```

### mkdir( token, 路径)

创建目录.

-   **符号** - 说吧 `token`
-   **路径** - 说吧 `string`

#### 示例

```js
const {mkdir} = require('@cloudcmd/dropbox');

await mkdir(token, '/dirname');
```

### 复制(收件,从,到)

复制文件/目录到新位置

-   **符号** - 说吧 `token`
-   **从** - 路径 `from`
-   **改为** - 路径 `to`

#### 示例

```js
const {copy} = require('@cloudcmd/dropbox');

await copy(token, '/file1', '/file2');
```

### 移动(按键,从,到)

将文件/目录移动到新位置

-   **符号** - 说吧 `token`
-   **从** - 路径 `from`
-   **改为** - 路径 `to`

#### 示例

```js
const {move} = require('@cloudcmd/dropbox');

await move(token, '/file1', '/file2');
```

## 相关

-   [修改](https://github.com/coderaiser/readify "readify") - 阅读带有文件属性的目录内容:大小、日期、所有者、模式
-   [浮动](https://github.com/coderaiser/flop "flop") - FoLder操作器
-   [丢入框](https://github.com/coderaiser/dropboxify "dropboxify") - 从dropbox兼容方式读取目录内容 `readify`

## 许可证

麻省理工学院

## 常见问题

### @cloudcmd/dropbox 是什么？

收发箱文件和文件夹 crud

### 如何安装 @cloudcmd/dropbox？

在项目目录运行 npm install @cloudcmd/dropbox，或使用 pnpm add / yarn add / bun add。

### @cloudcmd/dropbox 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cloudcmd\_\_dropbox 是否存在。

### @cloudcmd/dropbox 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cloudcmd/dropbox 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cloudcmd/dropbox 可以商用吗？

@cloudcmd/dropbox 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cloudcmd/dropbox 的下载量有多少？

根据 npm 官方下载统计，@cloudcmd/dropbox 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,825 次，日均约 61 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cloudcmd/dropbox 还在维护吗？

最新版本 5\.0\.3 发布于 2024/03/17（2 年前）；至今共发布 24 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/02/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。