{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"57a3bd8681383ed060c171c63ca9497e1fcf8f81","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.1.0-beta.60.tgz","fileCount":5,"integrity":"sha512-oBBRO6j2uQNtYlxBL7NzSESp7e4EDM2xIeNsyx8lbcEgzWJJOnzYbcvHpZghGZVtWPCNIxB9Lc5NX+lMEZxjHQ==","signatures":[{"sig":"MEQCIAF4xXpy6ehm6Z9iyCgw4fIPFAXRWYONFPqRn5yIRfctAiAmY765cYTayDdVtUiENBt7f/tycMyb5DV2x9INQwkYTQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":765621,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjY8sTACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqhOhAAgKExJF10EFjeAVg8gX1/2joA6VKuTGs+ClkZmMMHYFaWsvKt\r\nCNMn4oSDp1OOVd563DZldqB545vNE6FsbJdLb0rJka4dVEJRFxmf72HL+fPw\r\nzUO2TGdUH9nGaGrUId0S3uJa1gsToGie4Kb/cxf3lOb5nG3VvkfQtyMu9h20\r\nelkUpZEkUzIN6vVGo420BuEN+kuX/IBFNURWRi4KxadSoymkBDkF3KSEvasR\r\n2wytHKvm3THKtJNOMCTi5KUFU5Cq/dtdyqYAU1oTcyGRDrD3lnX097repumO\r\n6iz8icm1ErXTQ0f1VKuaRts2BfrQzB881lB5hg+TtW8JUaCQ1iAFtCTdwEyE\r\nSGpW9qNbahe2z38kZSkCYMg0ghUWX+eZVoSDOu98dmFzIALzNI/WqJTJvwuB\r\nAN2wbgj0+1YzECwkublSgTldV/Y0HUY+CTnE5aRcFIZvfoRLUylQUfeg+mDP\r\nZ7BQhFeZermqatXWSu01n6Hnw543smJVzzZrKFvpwfpOckJTgsNmD7RXjiZa\r\nsod4DwX4l29waWuIor25nPUnDte8piAbnfAeVUHvDxMf6TaxRYsJISjAST+M\r\nrQtiu4rxaW86WzZd7gDeFCU+Zkt6TtWJwPeEepqpvqJYPepRVzRxsOwY/YzJ\r\nb2fxCxQmVAyuWa3uK7URPUitjAlxa6E14tk=\r\n=NErH\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.60_1667484435237_0.8939452928004246","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.1.0-beta.60","version":"5.1.0-beta.60"}