{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"de003503ecb6c701f19383cc35df4a4eea80e23f","tarball":"https://registry.npmjs.org/xterm-addon-serialize/-/xterm-addon-serialize-0.12.0-beta.17.tgz","fileCount":6,"integrity":"sha512-36PVjQxU7j/CM+1xDLJ0cMCQmFDDobf/cVcR+xXnPN/wLjQnnRp3RUPmGX4tkXuREdFr0v8B2LhIfqZRPT1rEA==","signatures":[{"sig":"MEUCIEamHJrwDz+EUnnLB8+O78lhNZBEwtWk7B7BkpoyVitZAiEAszvZz+0Mu+yoAYhDhk4UAG6JtoFxsTZYCzhL/EkpPn4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":159099},"main":"lib/xterm-addon-serialize.js","name":"xterm-addon-serialize","types":"typings/xterm-addon-serialize.d.ts","author":{"url":"https://xtermjs.org/","name":"The xterm.js authors"},"readme":"## xterm-addon-serialize\n\nAn addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables xterm.js to serialize a terminal framebuffer into string or html. This addon requires xterm.js v4+.\n\n⚠️ This is an experimental addon that is still under construction ⚠️\n\n### Install\n\n```bash\nnpm install --save xterm-addon-serialize\n```\n\n### Usage\n\n```ts\nimport { Terminal } from \"xterm\";\nimport { SerializeAddon } from \"xterm-addon-serialize\";\n\nconst terminal = new Terminal();\nconst serializeAddon = new SerializeAddon();\nterminal.loadAddon(serializeAddon);\n\nterminal.write(\"something...\", () => {\n  console.log(serializeAddon.serialize());\n});\n```\n\nSee the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-serialize/typings/xterm-addon-serialize.d.ts) for more advanced usage.\n\n### Benchmark\n\n⚠️ Ensure you have `lolcat`, `hexdump` programs installed in your computer\n\n```shell\n$ git clone https://github.com/xtermjs/xterm.js.git\n$ cd xterm.js\n$ yarn\n$ cd addons/xterm-addon-serialize\n$ yarn benchmark && yarn benchmark-baseline\n$ # change some code in `xterm-addon-serialize`\n$ yarn benchmark-eval\n```\n","gitHead":"cb8917557d16d390b2d2c7c6ca9c56aaa8117543","license":"MIT","scripts":{"build":"../../node_modules/.bin/tsc -p .","package":"../../node_modules/.bin/webpack","benchmark":"NODE_PATH=../../out:./out:./out-benchmark/ ../../node_modules/.bin/xterm-benchmark -r 5 -c benchmark/benchmark.json","prepackage":"npm run build","benchmark-eval":"NODE_PATH=../../out:./out:./out-benchmark/ ../../node_modules/.bin/xterm-benchmark -r 5 -c benchmark/benchmark.json --eval out-benchmark/benchmark/*benchmark.js","prepublishOnly":"npm run package","benchmark-baseline":"NODE_PATH=../../out:./out:./out-benchmark/ ../../node_modules/.bin/xterm-benchmark -r 5 -c benchmark/benchmark.json --baseline out-benchmark/benchmark/*benchmark.js"},"_npmUser":{"name":"tyriar","email":"tyriar@tyriar.com"},"homepage":"https://github.com/xtermjs/xterm.js/tree/master#readme","keywords":["terminal","xterm","xterm.js"],"deprecated":"This package is now deprecated. Move to @xterm/addon-serialize instead.","repository":{"url":"git+https://github.com/xtermjs/xterm.js.git#master","type":"git"},"_npmVersion":"9.6.7","description":"An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables xterm.js to serialize a terminal framebuffer into string or html. This addon requires xterm.js v4+.","directories":{},"maintainers":[{"name":"tyriar","email":"tyriar@tyriar.com"}],"_nodeVersion":"18.17.1","_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"xterm":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/xterm-addon-serialize_0.12.0-beta.17_1694535086597_0.08170237476691478","host":"s3://npm-registry-packages"},"_id":"xterm-addon-serialize@0.12.0-beta.17","version":"0.12.0-beta.17"}