Files
xterm.js/addons/xterm-addon-serialize
Svante Boberg 14b02b9ad5 Bump minimum target to es2015
Now that we no longer support IE we can raise the minimum ES target a
bit. Changing to es2015 shaves off ~17% from the main bundle size, also
it prevents generators from being transpiled into regular functions etc.
so I would guess it has the potential to give some general performance
improvements too.

For fun I also tried to raise it to es2022, this gave a slightly bigger
bundle than es2015 so I think es2015 could be an ok target unless we
need something newer for some reason.
2022-08-01 10:17:10 +02:00
..
2022-08-01 10:17:10 +02:00
2022-08-01 10:17:10 +02:00
2022-02-12 09:42:08 +00:00
2022-06-29 09:40:07 -07:00

xterm-addon-serialize

An addon for xterm.js that enables xterm.js to serialize a terminal framebuffer into string or html. This addon requires xterm.js v4+.

⚠️ This is an experimental addon that is still under construction ⚠️

Install

npm install --save xterm-addon-serialize

Usage

import { Terminal } from "xterm";
import { SerializeAddon } from "xterm-addon-serialize";

const terminal = new Terminal();
const serializeAddon = new SerializeAddon();
terminal.loadAddon(serializeAddon);

terminal.write("something...", () => {
  console.log(serializeAddon.serialize());
});

See the full API for more advanced usage.

Benchmark

⚠️ Ensure you have lolcat, hexdump programs installed in your computer

$ git clone https://github.com/xtermjs/xterm.js.git
$ cd xterm.js
$ yarn
$ cd addons/xterm-addon-serialize
$ yarn benchmark && yarn benchmark-baseline
$ # change some code in `xterm-addon-serialize`
$ yarn benchmark-eval