{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"b020696e3d150445d1a281135344d424c4d83d64","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.1.0-beta.42.tgz","fileCount":5,"integrity":"sha512-EGJk8dVwFqwU2dnh9Txy50o+K8fdRjkGzMPcSLdWpZITDlFMvebncFKq/fKgCVBdNYqkFlIJyYTAcRiogsHvBA==","signatures":[{"sig":"MEUCICZAUW/nRqE9RO55D1V/03HxLmlWeJ1+YwSCx1G2kIL3AiEA8nqxZzH3OpogmgKq98wg/+97GS3//GY5tbbVUtr6Rcs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":768824,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjTBL1ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpq7xAAkSW9WdarEdw1nF9D1EI8i7CVr60sBIaVwwtfoJyW3s0LKLYo\r\nzFPECm8Z2GvBJZp9b+YDtTf+IGZibkqbOZ1s4xAY7T/HaM33CHDYd+zb2X2J\r\nLcQ1pFuNfkNpBnA9103CpZ1e5lEUFiVr01pvtgCA5aM17Rk8FxB03f4pjg2k\r\nOvh2wNATEKWegQ2N9c6bv/nSBD3bKKQkZfKK41HGJSOC+G93RGb4v28ZFmIT\r\nhWn4QVMhVJiO+LnOanTeYX6l1zvkG5QXXaVGjowRopSK4idioeIPZcz18kJc\r\nrBrl8KO7IMPZL+1cAPCaYlp+c8a/ZKtzdAlOpUHJ1LjrQtosbRAGn5wN/af2\r\nmWLfB4f7q2XThzw0EVtfQHq2dzzWiilSVADEd7UxDl9QRfh9RVd4zuPoQBDy\r\na72QZ7GOChY4zFnlReIb1nu6QNcq6V80tUZmtDfefd4rjvaQ3Qyc81J7BguA\r\nqmU3n0pIRbFuaHVuPELZcotWBZYgMvv7sDz1jL3JTCm7jdRPpZTQRwEW3AX8\r\nCmehuXUyk085EbK5PltdtE/ZUfAqdoAq4rxa9pjtkUGNiKoFot74v5Pi/OZ2\r\nwuxMp1g/nOQwN7pY4Loo6ruSzO0A1YbzI7ksxHMRO4D/Gzzhw7PfsiZDA06+\r\nAPAxoqNbJ6I9s5Z0e+3Gz3KLl8LnEJCaO8A=\r\n=s8KS\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.1","_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/xterm-headless_5.1.0-beta.42_1665929973634_0.21808504469854362","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.1.0-beta.42","version":"5.1.0-beta.42"}