trzsz.js (trz / tsz) - trzsz 的 JavaScript 版本

trzsz.js 使用 Electron 和 WebShell 构建的终端支持 trzsz（trz / tsz），类似于（rz / sz），并兼容 tmux。

请访问 https://trzsz.github.io 获取有关 trzsz (trz / tsz) 的更多信息。

入门指南

安装模块
```
npm install trzsz
```
或
```
yarn add trzsz
```

在 Node.js 中使用

import { TrzszFilter } from "trzsz";

或

const { TrzszFilter } = require("trzsz");

在浏览器中使用

<script src="node_modules/trzsz/lib/trzsz.js"></script>

为每个连接创建 TrzszFilter 对象。

const trzszFilter = new TrzszFilter({
  // trzsz 选项，见下文
});

通常，服务器的输出会转发到终端。将输出通过 TrzszFilter 传递。

const trzszFilter = new TrzszFilter({
  // 输出将由 TrzszFilter 转发回来，除非用户在服务器上运行（trz / tsz）。
  writeToTerminal: (data) => terminal.write(typeof data === "string" ? data : new Uint8Array(data)),
});

// 将输出转发给 TrzszFilter
webSocket.addEventListener("message", (ev) => trzszFilter.processServerOutput(ev.data));

通常，用户输入会转发到服务器。将用户输入通过 TrzszFilter 传递。

const trzszFilter = new TrzszFilter({
  // 用户输入将由 TrzszFilter 转发回来，除非有文件正在传输。
  sendToServer: (data) => webSocket.send(data),
});

// 将用户输入转发给 TrzszFilter
terminal.onData((data) => trzszFilter.processTerminalInput(data));
// 将二进制输入转发给 TrzszFilter
terminal.onBinary((data) => trzszFilter.processBinaryInput(data));

让 TrzszFilter 了解终端列数以渲染进度条。

const trzszFilter = new TrzszFilter({
  // 初始化终端列数
  terminalColumns: terminal.cols,
});

// 重置终端列数
terminal.onResize((size) => trzszFilter.setTerminalColumns(size.cols));

如果远程服务器是 Windows shell，如 cmd 和 PowerShell。

const trzszFilter = new TrzszFilter({
  // 这是一个 Windows shell
  isWindowsShell: true,
});

如果在 Node.js 中运行且 TrzszFilter 可以 require('fs')，则需要 chooseSendFiles 和 chooseSaveDirectory。如果在 Web 浏览器中运行，它们将被忽略。注意，它们是 async 函数。

const trzszFilter = new TrzszFilter({
  // 当用户在服务器上运行 trz（上传文件）且 require('fs') 没有错误时调用。
  chooseSendFiles: async (directory) => {
    // 如果 `directory` 为 `true`，允许选择多个目录和文件。
    // 否则，只允许选择多个文件。
    // 如果用户取消，返回 `undefined`。
    // 返回用户选择的文件路径数组。
    return ["/path/to/file1", "/path/to/file2", "/path/to/directory3"];
  },
  // 当用户在服务器上运行 tsz（下载文件）且 require('fs') 没有错误时调用。
  chooseSaveDirectory: async () => {
    // 如果用户取消，返回 `undefined`。
    // 返回用户选择的目录路径。
    return "/path/to/directory";
  },
});

支持拖拽文件或目录上传。

terminalHtmlElement.addEventListener("dragover", (event) => event.preventDefault());
terminalHtmlElement.addEventListener("drop", (event) => {
  event.preventDefault();
  trzszFilter
    .uploadFiles(event.dataTransfer.items)
    .then(() => console.log("上传成功"))
    .catch((err) => console.log(err));
});

TrzszAddon 是 TrzszFilter 的包装器。如果你使用 xterm-addon-attach，只需将 AttachAddon 替换为 TrzszAddon。

import { Terminal } from "xterm";
import { TrzszAddon } from "trzsz";

const terminal = new Terminal();
const trzszAddon = new TrzszAddon(webSocket);
terminal.loadAddon(trzszAddon);