clipboard（剪贴板）

在系统剪贴板上执行复制和粘贴操作。

提示：推荐使用 Clipboard Viewer（Win / Mac） 工具进行开发调试，让开发过程更顺利。

await eagle.clipboard.writeText('Example string');

console.log(await eagle.clipboard.readText());

---

方法

clear()

清除剪贴板内容。

eagle.clipboard.writeText('Example string');
eagle.clipboard.clear();
console.log(eagle.clipboard.readText());	// undefined

---

has(format)

当前剪贴板内容是否包含指定的 format

• format string - 指定格式

• 返回 boolean - 是否包含指定格式

console.log(eagle.clipboard.has('public/utf8-plain-text'));	// false

const buffer = Buffer.from('writeBuffer', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

console.log(clipboard.has('public/utf8-plain-text'));	// true

---

writeText(text)

将 text 作为纯文本写入剪贴板。

• text string - 欲写入文本

eagle.clipboard.writeText('Example string');
console.log(eagle.clipboard.readText());	// 'Example string'

---

readText()

获取前当剪切板的纯文本内。

• 返回 string

console.log(await eagle.clipboard.readText());

---

writeBuffer(format, buffer)

将 buffer 作为 format 类型写入剪贴板。

• format string - 剪切板格式

• buffer Buffer - 欲写入内容之 Buffer 格式

const buffer = Buffer.from('writeBuffer', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

---

readBuffer(format)

从剪贴板中读取 format 类型的内容。

• 返回 Buffer

const buffer = Buffer.from('this is binary', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

const out = eagle.clipboard.readBuffer('public/utf8-plain-text');

console.log(buffer.equals(out));	// true

---

writeImage(image)

将 image 写入剪贴板。

• image NativeImage - 欲写入剪贴板图像

let img = nativeImage.createFromPath('path_to_img_file');
eagle.clipboard.writeImage(img);

---

readImage()

从剪贴板中读取图像格式内容。

• 返回 NativeImage

let input = nativeImage.createFromPath('path_to_img_file');
eagle.clipboard.writeImage(input);

let output = eagle.clipboard.readImage();

---

writeHTML(markup)

将 markup 作为 HTML 格式写入剪贴板。

• markup string

eagle.clipboard.writeHTML('<b>Hi</b>');
console.log(eagle.clipboard.readHTML());	// <b>Hi</b>

---

readHTML()

从剪贴板中读取 HTML 格式内容。

• 返回 string

eagle.clipboard.writeHTML('<b>Hi</b>');
console.log(eagle.clipboard.readHTML());	// <b>Hi</b>

---

copyFiles(paths)

将指定文件拷贝到剪切板，支持文件管理器粘贴。

• paths strings[] - 欲复制到剪贴板的文件。

eagle.clipboard.copyFiles([
    'path_to_file',
    'path_to_file2'
]);

---