{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"060db83ce60edbd2d18114b80a1550ae663acb2b","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.1.0-beta.9.tgz","fileCount":5,"integrity":"sha512-arc0BkeeLW1tmQax4yo9LFOKwLjBTO8GuAhmElJiAUPSJj33YcifDWh7nGsxJgcVTskQLH83Gfxc3IEdy/XHqQ==","signatures":[{"sig":"MEQCIHqFPW9BZLJCF3u5EAcVVANpdVc23THY06wW4aLZx8dYAiBztOy4RtXB9ek1aoRuMaTd6SLmxhM2oihGNSHibXQKlg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":764903,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjMIZFACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq6Og//UhCYXPU9/CBi9I2KO9Sg6PqroQf4Xt5/fCY4eWY8BaHPcZZv\r\n66cRykPeplv/NR7KOIDzh6vrBpg0hr/Iupxi3aVPVy6pei0zQAjiArSCpmWO\r\nk999/5WuaE9yId0N2XG5im25Tyhz8AwUdrH8PRmHk9YyZvEurwNnTujtVpSO\r\n1qdUiApt//F5/Md3+e9IzC3r+RgjlNIfyLkHjaPdsIixGfNnrYxC1nV3OkOQ\r\nFUiNAfvmdq0UTK5LJ3sSO6ig8bHr5XIagY/v7PqW8FocxgXzTbD/f1ksZD+R\r\niaIttDouM3IQpfWfvCI4psQMSwg0XNhc8yk1mukWSHuyg6wXYDu+jIPdDfjw\r\njeYVIVDhlVT7eNIk2VNqGjMYOEPq8LOWsBrCoZ0GCQcoiqV2RWE1KuCqCjAh\r\n6R95gn664t9WZjiOzw6gdD0oVy2qzRjNWsUBOTgYRBBgPN7QdT/xqxCUBAPz\r\n22NVnrJ1zWx7hvA7pAdEcwoRkzdj8FNgVpFNqLlKWa5putHmqe8wDq5xs1IY\r\n9gMXG76bE/Z7QtozkWs9m7JPXgOWUkvnbfP0pbGA83ocayfdkfrWPa4eCVlT\r\nUtMudOjC1GiWhepBWd5o5hFul4UoNLi7D5FfCtMNgK1N+vQ0aNhpZO5WY8z4\r\nCKtdO/Kj54EiWlJKfOXDV1pr5lbchrgOa7U=\r\n=iZpT\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.20.0","_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/xterm-headless_5.1.0-beta.9_1664124485188_0.8473446303489485","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.1.0-beta.9","version":"5.1.0-beta.9"}