{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"1ae49c86e2e56d3d1bdbfa71c08d7e063c34ca8b","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.1.0-beta.20.tgz","fileCount":5,"integrity":"sha512-oZBeAxYnm531QqMtCebPz3eLJgKT3/nsIsWOWrfa9/XEfWsi6FBj2EDHOrcx2GfUYPaO2imoWmYOjHEG+ftiIg==","signatures":[{"sig":"MEUCIQCl16rspx8YScrV07DgDUE4Y21Fc+nqOVBmUb5ZmMgLlAIgM56SPCxVTJ7VCN6+UhKv5Gd8+/2gSagGUzdryio2r24=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":763353,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjORnhACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmowOw//UcjgDlbUQkMtHLeHtcNulDe5Sv6+y83IvRdLaPGWrYSnfE8H\r\nhBjMtpyZHkbsTw9wvis6waVBIVcNuD+KAPxPPQR1afiffSLTLtwQwbgvFJka\r\nhP2c79wDIGbOgsfjPcQlxb94TDVAHV0vhAJi2OjIyPyH6opIFv5aViYQWeyF\r\nCXVPsHMTKdM4QKXBJJk7aT5L4UsA5skWBTDxJB48uPdcLUiP9JYjLtWWEytr\r\n8XL1Lbj3VRApRHyWvzMSvP2SgDHpLkaPfUQPmMs8hsR18Aauuk3f+HqWdwDL\r\n1xIXZkDH+bj8pAtFLXY8c5/b3FMdIVN9HHPdLPdbdYQ7/lUna0Q74+JlqGTv\r\nvFtaJZgBZA9yTtkvTUoUZYLpUBOZdCEFCApX4NVdQiWOA9f78RPdZ4C6xh6/\r\nrWV5ALrg69p5FhKo6gZmXY+wme2ZN9NmFf3oWPkVrssdV5S1GcDTyU/iDBjo\r\ndoT6l5P3lJCaAjdB6c+34m+kMVqF1e8JmBKOJs9gnUDTr2F88Bqy1IwtDFU9\r\n/MJ7ixiEn36+3yADovnyJbrfDlu1zsNv/VwEtLy//5Xn6BNNr/YBH+bHp7z+\r\neLG3bGeY6dCtVi1x7PmpwBaf2Lupwb96l1Uo+FIYUR51KbMgIwnoweT9+msQ\r\n3vl2+hPKBzt6Y7Lt1AwyL3m2JK3YR5Hll18=\r\n=LeMW\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.20_1664686561514_0.22263498802189874","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.1.0-beta.20","version":"5.1.0-beta.20"}