{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"27629a718fa99cfdca6f9bdc640939650d272539","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-4.20.0-beta.28.tgz","fileCount":5,"integrity":"sha512-TbOFGC7a5x47wVhE2BqxSScIHz6J/cpknBKxK7+NzGstrRe6iG2zBpIP2O8xHutYXIMDI70VLbcHdTq01p7yjg==","signatures":[{"sig":"MEUCIQCtRTdoWVg9rL5I8O3Zfgp4Jhkd7N/1YYcywkMQbU5duQIgYTiJaPe/oV7A0OwClh5nIZw4NEi1dbAFhK1d4v7YVjg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":772709,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi4smBACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqCiBAAl+FHVVQS5Rcnl0K68HdZiE3AU3dbUnHT+4Z8Z0sxEhQqzw3O\r\nfNCUP+612LDcyRR8AXWbMkq9Kdq4dwiLdKR4k7LMGJb3UUbLCRoqUo32OtKX\r\nRbOjs6c/KYbL9raoelIQ4vpHz9/gpgmm/6Zm7JSFZ5MqzQNSSpGaV0/vBDyj\r\niPgxSk1Ed5PINQFGTdovlfabe77Ccs5fmB2R51VnecVklK8BYO9MWz2DhQc4\r\nQ6t5yDdsCWFq79CwnVBTmcRp+NxV+7XBBxwjn4Bo3vxMYg8ND5oUe3UU5Xe4\r\nFC3mM+k2a0U5Dw1/nI/0tAJ9xTHdAN7otA3f6tPoaxFIVImkjuok7T67OuJ5\r\n3QaH7wIggbhbt+WZlA2aalAe2PU0qRE5lKiQgXGppe0gN1fOS2a+E4V18PI4\r\nldwTUFsjNcqyGl8TEBuYczKuf5qz9+Q+ZO3NDAkHfGh3iWhlhchhgfpQQrxj\r\nPIAv+gGsuhpa5DhV9u0SxHlLLGUQcH7WzFYXwNuCu/6kzYni0YF0Fz12Mikf\r\n6zJGZFOrlmQC2Gk7IWOhEF35zkCdXGYdEcRt+zAQYfYTyS6Xsc7+ybHuNh4I\r\nUCAGWJSU9OAgc8VrlRuDxEWKXqQeD8bS3ISHR0T18fhqNJwp4P43rYhADaGo\r\nmx3FF59ATOo4Oh1tXqe4wOLolBEc1yBoubc=\r\n=661Q\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_4.20.0-beta.28_1659029888933_0.5012633871686956","host":"s3://npm-registry-packages"},"_id":"xterm-headless@4.20.0-beta.28","version":"4.20.0-beta.28"}