{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"528d07f159eac955e5f49f2228408a27dda4c360","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-4.19.0-beta.33.tgz","fileCount":5,"integrity":"sha512-LTJepch7kr886X4W/aSFy8N4nxc5L5qihYlIjnu1LnrFk/WDFWM1TTKPzFkpPZJdv/QbbQRU1po9YsHpC01MaQ==","signatures":[{"sig":"MEQCIBy8lJ3p8M13lm0UDJnvzM84gWX+5rMcNXY0+tozoaO1AiAyTHx8GYCSw8fNOst2Eu12sqtXhZVQYxkfrImN8rCF9Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":775331,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJifVk6ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqELxAAhPAd4Fy30oNyC11DrAI/qpVY7ko682hePmuZDRmKl9XUGtiW\r\ndUoFOKZjSyyVNL0oMqjElMKxFSQ4HwRDnzUDFSJq8+EiOMCoRbniePfITdXi\r\nwUpG5T9uMGSz+UDpLvVHIrKWjpFqQV+VEi9awQW294pWwy3HlFBKbZZeU/qL\r\ngOFo43whzTLoFq6aHcYxn9w78aIQ1guLHpArzSoftG7xVQ8mZOAPC5AStS/e\r\nwclJpM7Kc9YsRZNmuV3syF3oSUQwOzgzkryDkBojx6xfU2nFyqKsUCNsQh5J\r\nYh6l5X2yrcjpX7aGSpoD+QDxbGczuu4/Aa9ATD/u8CypgEvri/SP9DI3gXCd\r\nUE+PQIcH/Ka2wOYTlR+Jw8ZJLVIt4JBc6eYXdTpuYq+Yuzs2pLzRKs06W7ch\r\n5S13lViI63+pEvjFkNwLYGkoiPNIv8/z4b47MTgrdyZrkwyIqmWPPQXEgV79\r\nyBjEGj0tWAjHYRdvTT0GlCd9Jism2R6OBypGEFaPcFZUOKR7TvP6CgQsf4z4\r\n2AyOnGB1dBYlKiCg5mTxbJDwXzJMM37k+P3oECgfuorJ5V2CqLZKF2yc67LP\r\n7Xe0qYZ0nLscaa8lN3RVi5e/QC9kMKHyRcZa4loitt1xgmaCC+NwaHhyB/bb\r\n6fQtlixLmtU6UbMN8sn9unO3wKnGqSGLPzQ=\r\n=nQx+\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.19.2","_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/xterm-headless_4.19.0-beta.33_1652382009877_0.940965416056039","host":"s3://npm-registry-packages"},"_id":"xterm-headless@4.19.0-beta.33","version":"4.19.0-beta.33"}