{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"19acf8581700fec142e5e1f5f2769c80820f5be9","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.1.0-beta.3.tgz","fileCount":5,"integrity":"sha512-8z3yxnwylpx8+5DpaaxG42d2fgCEh84JqP3zOmCyEdm+o0iMm/7Ah57nKCJgc4uT2L/Kimr/hClPvu89BTAaMQ==","signatures":[{"sig":"MEUCIGOW6NZuG/eFPxZ9k9H8YRTqmpQzBbdJjNa/Rtmv7qk+AiEAwFzJ6ptgtlyPPcTSIbnT0sw2C9Uds2PCjgbXIy+lkJU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":764833,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjLhjrACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmri8A/+ML+vQL9eJyU1hOaQ+rPto4TeGdTNrVhOy9W7m4gPgmDix8ma\r\ngZBrLIjX4vci7UVlIfJTPA+yETbR9DQQ6LHpDFm5Ht4ZvtbW4+qXuoHtVuNm\r\ng9fbNNg6xwcwbAbW+CAdxi2UXkQmBqjTqftbNZwH8E+kPMeV9A5eMTDpV4Ev\r\nggG6ymaHJp+sXzzc13nRnQ0XwlapGyJLFMw7uKyrjsYYe3GjYM/kNwbNVwxx\r\nEYnQ+d01KRiwFO6Qu8SZVimAIKOmLmYlwtgRP9NjJo8hry3sQvmy80sCenhJ\r\nG+ygOuCv43koQuDdfW+YsMpQOIi4JEPNsjVRCTezy+PGlqDZUg87puj4c8pR\r\nHxPaOlXVhSgQM5Nf7kWB5qatZwm20AdEztOSXLIIurVgpztdTzY2v6vheG4i\r\nWasnih10e0F0KwMPZ8gasb53oO8WDg1GpBbZCzsj8/co0/SooFRxokD7R9W4\r\nvPfmJeXUE9bdTy5Fc2/NzCbIpG1CdiMLywtpkp9EJ+HuFtkBNceA8gMCO0Ki\r\nNDuO+Ynb1Fj7TKZz0J/qJMNxRvSXNGjr41peY9CxukIjilFdc4dal7JG4b6m\r\nZiju+SfoVoHjZis48F1UjRs+07xr0J361vO7fFdvazKOIklZzAFcCkx4RT0Y\r\nvnPpOtwWkDiOgOSsLO4EvYeLk+huRbpbf/0=\r\n=ri27\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.3_1663965419360_0.31680700447563437","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.1.0-beta.3","version":"5.1.0-beta.3"}