方法参考

本文档详细介绍了 DataMover 类提供的各种方法。

构造函数

new DataMover(config)

创建一个新的 DataMover 实例。

参数

• config (Object): 配置对象
  • source (String|Object): 数据源配置
  • destination (String|Object): 数据目标配置
  • options (Object, 可选): 其他选项

示例

const mover = new DataMover({
  source: './data/source',
  destination: './data/destination',
  options: {
    concurrency: 4
  }
});

实例方法

transfer()

开始数据传输过程。

返回值

Promise - 传输完成时解析，传输失败时拒绝

示例

mover.transfer()
  .then(() => console.log('传输完成'))
  .catch(err => console.error('传输失败', err));

pause()

暂停当前的传输过程。

返回值

Boolean - 如果成功暂停返回 true，否则返回 false

示例

if (mover.pause()) {
  console.log('传输已暂停');
}

resume()

恢复已暂停的传输过程。

返回值

Boolean - 如果成功恢复返回 true，否则返回 false

示例

if (mover.resume()) {
  console.log('传输已恢复');
}

stop()

停止传输过程。

返回值

Boolean - 如果成功停止返回 true，否则返回 false

示例

if (mover.stop()) {
  console.log('传输已停止');
}

on(event, handler)

注册事件监听器。

参数

• event (String): 事件名称
• handler (Function): 事件处理函数

事件列表

• start: 传输开始时触发
• progress: 传输过程中触发
• pause: 传输暂停时触发
• resume: 传输恢复时触发
• stop: 传输停止时触发
• complete: 传输完成时触发
• error: 传输出错时触发

示例

mover.on('progress', (stats) => {
  console.log(`传输进度: ${stats.percentage}%`);
});

mover.on('complete', () => {
  console.log('传输完成');
});

getConfig()

获取当前配置。

返回值

Object - 当前配置对象

示例

const config = mover.getConfig();
console.log(config.source);

setConfig(newConfig)

更新配置。

参数

• newConfig (Object): 新的配置对象

示例

mover.setConfig({
  source: './new/source',
  destination: './new/destination'
});

静态方法

DataMover.validate(config)

验证配置是否有效。

参数

• config (Object): 要验证的配置对象

返回值

Boolean - 配置有效返回 true，否则返回 false

示例

const isValid = DataMover.validate({
  source: './source',
  destination: './destination'
});

if (isValid) {
  console.log('配置有效');
}

DataMover.getVersion()

获取 DataMover 版本号。

返回值

String - 版本号

示例

const version = DataMover.getVersion();
console.log(`当前版本: ${version}`);