{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"143c280247ec942d64ae5f0b334813a499c00030","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.2.0-beta.25.tgz","fileCount":5,"integrity":"sha512-u1A6bCKR0y76SRZryjVaF21H1Xjb854+sXVQwKCrNGqmtAR9pHCrZs1iaf+mfMBdBYJ9jrJH0FEuQdyhEcqafA==","signatures":[{"sig":"MEYCIQCFaEI8PxyTkITvmGsYdOo7LKeUe7iwik5EjnxwD3oxjgIhAO26+6LXYIx/23O94/A4sYL5+eDSnqP2IhVkOezT26uE","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":773276,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj3BWgACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrakw/9HFMahVazp3en4fLCO1YKyPLzbcHzcl5yaGHB11phaYGkw2NI\r\naEdGhQzMGRzhbI2Oz1mFtlxJBGlb2jz+ujXKBGjBA0TltzVYrir8HcYyfklP\r\nnikshvOL55brXCTAeD7jagHVMgyYdKFTxDNt+zb6EVmpdcP6DQxhmGmmc8Lu\r\nAAcUDUAvXYRhSzpm1qlfqzTsSlYf18oVyPA25XN26l+6wSxbocJxpM1dAFVA\r\nuYJcV0eTIqY/SHKhV4wNTpaLtdiLAD7u9PLwRxfwufa0Mrs/Uqdn+P2DnEDW\r\nHouYrZdvUETR/pt4P7bprpfQSQGXK/TJeQHie1DK3Zva7oZit7qyxa2Gk/20\r\nG2o2yYTr7arypZBuhlmnL9vN+sGnMajTqDTFi/hbB5yTyEK2iot3FqW/i58p\r\nnAeDCLRb06vkiA1XsOVclTwCyV864EoV32jN3pleywdI7f972hPkMiD22118\r\nnUCuPMiGN4Dpe+nG4ete/UCykwEDAUncmLR8/bfCzvSl1Gz/c7WGNxQdyg5t\r\nBH0OavRselXIUZWAHo+Te3Pxhle0Cag4QyHB528/HwvzV5A9kNM+Qs85jXju\r\nqscJ/fQClHXz6SHMhk8pwLA/FWJhSvJih4/UiObW9/IfXc1SuGBFi1JW7g6w\r\nKMcTLoHIBn7m9Q82r0seARdGvLIg418UeNs=\r\n=PEiE\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.25_1675367840228_0.8973785719275069","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.2.0-beta.25","version":"5.2.0-beta.25"}