{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"40be1733ecb74621a428fd575309af0e4c844942","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.1.0-beta.34.tgz","fileCount":5,"integrity":"sha512-uNEYI4A43QjzpGjgAZVSPiH5TZly5FtKluMWorW+1YJlj2hoBDSaBHf1e4GYYxcNqdbLnB7evsblYHOKhKVabQ==","signatures":[{"sig":"MEUCIQD82EI6Ga1eknJ93UO8Fj68aERgQ2Sdobgf3YkLGCXooQIgM0agyV6/DJuKpo/eMTKQgKuEdpj+seUEV2pNcHljjy4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":766212,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjQvd4ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqMrg//bez1UkCnX/rwGMg4L2NL451/OJ5pBYP1eXPFADpoqo8OQKzk\r\nX9ZEfBHAan2qr4pfpVCUbZzW+V/yGQovX8cpPoFR2JXTx4b80FKq/UbH1AWn\r\n2eO/2twNH2Eptki5nSFKO0Qgu1HsqkyRgDLjE7CxhG9G2eaEAM0LhlllR/Fc\r\nmlNVj7bRmPrRqlG8ZCH1ziST3Hes4Oe9cFcJpJMtqaq7XGo/kt9nmfRNVceK\r\nDXaB/aDRMYiwVwYxTTRJevCckLuUTfIel3D8WC97MB0hsLmfnpIbevkfrJsH\r\nhzE5j5YF2Eulgep6DYN/WVxef8a1bbTxQmNEQzdm8pYKqFCbQEX41CFhdp/o\r\no027qep51o8vOtX0R4bEvnuL5p0cxXwfmomajgMyZ3GjGqPLjuqTzxhO+GYt\r\n9giwzrjI7EMxZ8yRKAvBcQvdyQF6h6CPxlT6JDXo7IPRoMiFnDaPjJzVIrQa\r\nO1zhnHwleLcCuRBVzkEFnBJojZI9tWt9VsuCRDQOQDh+ihRlcbtRX/T0ScVq\r\nYLltloo8/fb4VNGZauTr2vtVS41lZ2xV+8vqTQFnO0kDLr/s4rddEJTmb1t+\r\nyn+zqgQNyYRMYZaurbXlLhVvNXkeFJesng3ebVF3cElQROQtVVOCxdVedR7+\r\nj1dg8PRc/dUh8rBeqrzEEILyZLzZsIkEntE=\r\n=nB5X\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.34_1665333111808_0.07173033358008185","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.1.0-beta.34","version":"5.1.0-beta.34"}