{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"984a9f73f2b7ebd02bb8b1b9bbdac84825adbe84","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.2.0-beta.3.tgz","fileCount":5,"integrity":"sha512-5riC1Mq/d2IceYqeRu9+UnNLyZF9cIiyStxe4DMyUglM2ZY2+AA8GaTyUNMyqcjPbSQBm0/ar0+6EKqoMZaw5Q==","signatures":[{"sig":"MEQCIBxRxVqxK7JfIPnSxs7ojJL3L8Hu8rRtTNgSKCQ2EE/pAiAK6GpkpWmjArUj+26G/1/JiJLEolEu1/A28q38picxaw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":774109,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjozbHACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpGYg/8DJnJ06KilWkdcj4MuMAA9CyUaDdfbLyf0AtcIGTTlwDzh7bB\r\nceaiFDo2HWvko/qUILImnAAjRPUfgqkZuH54CRpWoRwbOrbM++9+quf6Y+1L\r\n7RELW83EczAWLAtfVwbZTjkLUsSVnGXWZpAp/cC8UllR9gSOfY+Il89OcO7R\r\n8GdVAP8v2ep7lMaQPR5GRz5I5Dd4T/zWun2SVhh0UlPqP9UAO2VTeok5rT2H\r\nCu7GZnSoRQjxuY0xV9ZLkQC045uDPwP+cTrzFgna52ufOJ7VQRe5YPrb9pur\r\nSoHUZ/C/fgjJlBRkU/TTKgdbJo36cpePw+eGxPgzXyNooW1eP34z+IsK6iii\r\nyQKktIZP1YHYh199lHc2escAlPnyIi0WLusqQmq2fwEZ5o0OpMSv1hdKe8bZ\r\nyrMN57H/5IZId9c2A/7AWsdhDC5bEJ+PQfJHniUL+qlv0EyZkMNFTJnWlzKp\r\nMrIR2SmUYrSeqwZ0++aV33n8WDvBN33OawBEU7CltjZRyIKmapTncpmbAuzH\r\nC/AG0KqIxsUokKwW+UrCASWbEh67g5M5g7pgNvVIoS9ozP7Ot1B069gL15qr\r\ngHEUWdbDyorJC4nKrEPbWvqffTAAKDwzOTG0/Fu8NONyF0QRAAiW8cxgzhv5\r\nS4+XniO61+egU0FcYBGLDyXcUtDArPfBXlc=\r\n=Q183\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.2.0-beta.3_1671640774806_0.37213115096349325","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.2.0-beta.3","version":"5.2.0-beta.3"}