{"bugs":{"url":"https://github.com/xtermjs/xterm.js/issues"},"dist":{"shasum":"ff1ae4bf9a9962410fb46dbe19c73f9b93ae4539","tarball":"https://registry.npmjs.org/xterm-headless/-/xterm-headless-5.1.0-beta.13.tgz","fileCount":5,"integrity":"sha512-jbCCuJgpnv1Ncda45J08wlEAVEReYQonFx9Nu9YvjQyvnN5h0PkIAztFHHO3bjRPFHCC44fPfcmvJOvA4pZAZA==","signatures":[{"sig":"MEUCIQCC3EdBwGf1vYQn/wAmbeE7+UYlleFYbN94Nq1asxwbEwIgKazO8oLj8sJrGtz/0wq+zbCAoiW7gDx5WjPR/HzMOfU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":764904,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjMwPBACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrfqw/7BKoUAXIqTX/B4/e2X2Rs8FE2Pjl9TtHG8elYH/bLEp0Tpdyd\r\nmxd8LirYPrxIXABNWNRk3ekPjo+5qwriVGdpky9lpLXmzWSTDY5v4LS6f/uz\r\nspB+JeC+Ble1BSqreeV4bNptYYLXM2j7re6G0M/GBbQL0COWRgO6IuQcVZkS\r\nJGyl0wtwbGA78assH7WIEdFgFUx0FeIYTMcaZ3dwivfqlVdNMjbQDJpwRVcP\r\nOyP3seuvvJiEFRV3rlBOSnEP60w5p+zlAAiCsfgDv1zDBG/jlSfKrSSoBlDT\r\nir/w/59nRiATLuyGKfgQh25gqCDivmWs9BViI1/zewCYY24wIPZJr542gXFB\r\n9y/HHx3AH55yvAnXVowSmjBEnzOSqm09vgG1lo+tDE3y8pL2WAqPx68v6KsJ\r\nTP4e75fsTRSnodFzkf1ewJUnngWlJ/bt7hhzeI+lz0PkuIzbqTYcnfECbkqu\r\nlkunwLSWOLS2VHlsM/P92PalCzrOD/KF6R89DB9y/n7YABt2LpQdoMV6Mrvx\r\n+1CmUsgoOrlp1C5uG6W2TDQCDUdBys3zY+tcT23kPx71uHslhVvpsTcomhJG\r\nfufW/mz8/kiMHkh4scU48HC+DSP7Vh+c3jDIhqGmsOhV4t+lP/JifwriMq1M\r\nvM1J2gQqZ7S/Tw2plwHC969k6GYFV72Z05A=\r\n=TnUd\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.13_1664287680822_0.5676269178327027","host":"s3://npm-registry-packages"},"_id":"xterm-headless@5.1.0-beta.13","version":"5.1.0-beta.13"}