{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"5827ac8977b5ae3246cc217dccdd6eaeac01b66e","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.2.0-beta.20.tgz","fileCount":5,"integrity":"sha512-D1y4CIRvA8Izo7tAWShbyKTnxVteAy+N1j9Q+xvzcVxsGA4DLa8U7Gr2KXs3e/cjgkDcVHbbYCn7iWEyNTFvWw==","signatures":[{"sig":"MEUCIQD5s67eRHBm7tT60kzksSh3Baf/tZXcPjjeOq8kiOrYxQIgFhVzdVvZhCnFJCXrgHZEiBEuXUvjx7uIkaDKgRVFijU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":774102,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj0AHNACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr5TRAAowwvPk5rrB8yhHZt1qbhRueHwqUpwZTMfj4IgyesZpswvnOG\r\nboDAKzq+qQCaMH3rmyuMYU8OlO9BFc5C8EwQcwu3OnIPdyQuJDJ+dHziNjcM\r\n1+ktG4zWd6KaEVrbbnMHgxx2EcxbcnWUO2f6cqa+JC67yUD1fa1RrKPQ0BPO\r\nwmhpihBdmMMjVB8ERSsN7vsGH4msHlMIuR6Sg0+qulZuVZSMQygqnd9theo4\r\nyNvudU1sz3gqW9Tcqa42gZRrdZJbZ7Abh0ph3twX6OBrjnY30k5Gt3CMddUC\r\nzHsH2s7jXa/C7zQeZ/3JrKp7nPhaxQntQKWkvmjC1OupqJ9Y/RJgIP7zGkzY\r\nnmJAv/pYMuRhfAdMBKI+bPRm/j6sh6hQexrGeyNwni0HjBMyQOb/D5s2DGP5\r\nDHoXJKCDIJxXwoqFSJs5zK17MLJh3mUTGVTbbXD0Ur2r1KgxYLQFL7khCScp\r\noOjgogsHDfTMvf+39HPWZsQdRXoO7SAt4cmfdBVYDrLnl/lN+Kq943q913YU\r\nx8k7gytnKKHwY5fcl3mdzPDFuvz4HhEmnJniHDMG6ArKPJItwAJ3PJL6Z1K6\r\n7z0B8ceWBTt2cGjFtoJTzCIVdaWHZJiMEa6oNWgDwIWDYUPFcyzMGmbRYou+\r\nf+u4P+hOLDqKIOOojomo8XOnUDd3n+LAjm8=\r\n=G5iO\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib-headless/xterm-headless.js","name":"xterm-headless","types":"typings/xterm-headless.d.ts","readme":"# [![xterm.js logo](logo-full.png)](https://xtermjs.org)\n\n⚠ This package is experimental\n\n`xterm-headless` is a headless terminal that can be run in node.js. This is useful in combination with the frontend [`xterm`](https://www.npmjs.com/package/xterm) for example to keep track of a terminal's state on a remote server where the process is hosted.\n\n## Getting Started\n\nFirst, you need to install the module, we ship exclusively through npm, so you need that installed and then add xterm.js as a dependency by running:\n\n```sh\nnpm install xterm-headless\n```\n\nThen import as you would a regular node package. The recommended way to load `xterm-headless` is with TypeScript and the ES6 module syntax:\n\n```javascript\nimport { Terminal } from 'xterm-headless';\n```\n\n## API\n\nThe full API for `xterm-headless` is contained within the [TypeScript declaration file](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm-headless.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API.\n\nNote that some APIs are marked *experimental*, these are added to enable experimentation with new ideas without committing to support it like a normal [semver](https://semver.org/) API. Note that these APIs can change radically between versions, so be sure to read release notes if you plan on using experimental APIs.\n\n### Addons\n\nAddons in `xterm-headless` work the [same as in `xterm`](https://github.com/xtermjs/xterm.js/blob/master/README.md#addons) with the one caveat being that the addon needs to be packaged for node.js and not use any DOM APIs.\n\nCurrently no official addons are packaged on npm.\n","license":"MIT","_npmUser":{"name":"tyriar","email":"tyriar@tyriar.com"},"homepage":"https://github.com/xtermjs/xterm.js#readme","keywords":["cli","command-line","console","pty","shell","ssh","styles","terminal-emulator","terminal","tty","vt100","webgl","xterm"],"deprecated":"This package is now deprecated. Move to @xterm/headless instead.","repository":{"url":"git+https://github.com/xtermjs/xterm.js.git","type":"git"},"_npmVersion":"6.14.17","description":"A headless terminal component that runs in Node.js","directories":{},"maintainers":[{"name":"tyriar","email":"tyriar@tyriar.com"}],"_nodeVersion":"14.21.2","_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/xterm-headless_5.2.0-beta.20_1674576333065_0.5239712946808099","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.2.0-beta.20","version":"5.2.0-beta.20"}