@zkochan/pnpm

{ "_args": [ [ { "raw": "unpack-stream@4.0.0", "scope": null, "escapedName": "unpack-stream", "name": "unpack-stream", "rawSpec": "4.0.0", "spec": "4.0.0", "type": "version" }, "/home/zkochan/src/pnpm/packages/pnpm/node_modules/@pnpm/tarball-fetcher" ] ], "_from": "unpack-stream@4.0.0", "_id": "unpack-stream@4.0.0", "_inCache": true, "_location": "/unpack-stream", "_nodeVersion": "9.10.1", "_npmOperationalInternal": { "host": "s3://npm-registry-packages", "tmp": "tmp/unpack-stream_4.0.0_1526240984664_0.4813786125764914" }, "_npmUser": { "name": "zkochan", "email": "z@kochan.io" }, "_npmVersion": "6.0.1", "_phantomChildren": {}, "_requested": { "raw": "unpack-stream@4.0.0", "scope": null, "escapedName": "unpack-stream", "name": "unpack-stream", "rawSpec": "4.0.0", "spec": "4.0.0", "type": "version" }, "_requiredBy": [ "/@pnpm/tarball-fetcher" ], "_resolved": "https://registry.npmjs.org/unpack-stream/-/unpack-stream-4.0.0.tgz", "_shasum": "afd8308b0dee313022504aaa11cd945cbe1c5ba2", "_shrinkwrap": null, "_spec": "unpack-stream@4.0.0", "_where": "/home/zkochan/src/pnpm/packages/pnpm/node_modules/@pnpm/tarball-fetcher", "author": { "name": "Zoltan Kochan", "email": "z@kochan.io", "url": "https://www.kochan.io" }, "bugs": { "url": "https://github.com/zkochan/unpack-stream/issues" }, "dependencies": { "@types/node": "^10.0.8", "decompress-maybe": "^1.0.0", "ssri": "^6.0.0", "tar-fs": "^1.14.0" }, "description": "Unpack a tarball stream", "devDependencies": { "@types/tape": "^4.2.30", "got": "^8.0.0", "ignorable": "^1.0.1", "mos": "^2.0.0-alpha.3", "mos-plugin-readme": "^1.0.4", "package-preview": "^1.0.0", "rimraf": "^2.6.1", "tape": "^4.7.0", "ts-node": "^6.0.0", "typescript": "^2.4.2" }, "directories": {}, "dist": { "integrity": "sha512-c7fW8JV7WVb8BT0fZyuEXUi4SzqlJzCQFOytjjtFJH+ejDllZAzsIJjGjttWJR+0xqS/q2+TGvGm+GU5Jz/k4g==", "shasum": "afd8308b0dee313022504aaa11cd945cbe1c5ba2", "tarball": "https://registry.npmjs.org/unpack-stream/-/unpack-stream-4.0.0.tgz", "fileCount": 6, "unpackedSize": 11525, "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa+JbZCRA9TVsSAnZWagAAdkUP/0fI4tRZTqFtGkwruJXu\nyGyDAyWTgJ5IK5egCAlJceD3KHkU4LlZJDg550rznpeKjE5ar1oqYPfUcq5d\nXneFIqh2mqhoHOS24gTX2RQGs5W+EXVQHLBH1wFcqLtih1ZT83XrnwSRGSLe\nRixu7uB6gOB2Zq1rZU11pLtaxn4mkEkwciydGE8/2EcXRlSmMvFd4u0eUFMX\nuKSOv9ALOGRmwoA6LAujSnJu6eaPfcfSrW/cDGaPfMkeMJcMEXgOZFFU1cGQ\nCNnFr5rl5X+ZdmzVO5TLNj/HM8ilE622PN5+P3XTp0BjXeUNeukE7AN6jpif\nLum7hmOTsYBF5hl8xyAS6QvmMv0uBI2J8+MWJt5gFF3gfr3pVCT1oaShUYBa\nLIXiFY1eQDVwny8wgVqQ4m3iHAkDMjJrUPsuyVJbo/wpILYR2g4hjOcutpQg\nlNQyQdTk6wTsMUmtBAA5+k8zmGp+VSRC+WxrzUFF49/DnOyroDYUnmnSSCt2\nhPq8/NibjA0vmrI5v8X5v6BdrKkNbD/KD2SBoJ96By8p5biqmFyj++gUeKAW\ntAPIUnWjN/W3H7TPBr5C6KwKVVoegz5EVYyyzcbO3rnxPFhJohizbtOLACEV\nPCVjYTaf6cheQbTTvNJDXHY0TuJ7wMLwBU0mzlfWgn9vPKq3+mryQABzEmZX\npEAb\r\n=V2Ij\r\n-----END PGP SIGNATURE-----\r\n" }, "engines": { "node": ">=6" }, "files": [ "dist/" ], "gitHead": "8aa0e39fe1b71bc1a415edb92bcf7596737cd4cd", "homepage": "https://github.com/zkochan/unpack-stream#readme", "keywords": [ "tarball", "stream", "unpack" ], "license": "MIT", "main": "dist/index.js", "maintainers": [ { "name": "zkochan", "email": "zoltan.kochan@gmail.com" } ], "mos": { "plugins": [ "readme" ], "installation": { "useShortAlias": true } }, "name": "unpack-stream", "optionalDependencies": {}, "readme": "# unpack-stream\n\n> Unpack a tarball stream\n\n\n[![npm version](https://img.shields.io/npm/v/unpack-stream.svg)](https://www.npmjs.com/package/unpack-stream) [![Build Status](https://img.shields.io/travis/zkochan/unpack-stream/master.svg)](https://travis-ci.org/zkochan/unpack-stream)\n\n\n## Installation\n\n```sh\nnpm i -S unpack-stream\n```\n\n## Usage\n\n\n```js\n'use strict'\nconst got = require('got')\nconst unpackStream = require('unpack-stream')\n\nconst tarball = 'https://registry.npmjs.org/is-negative/-/is-negative-2.1.0.tgz'\nconst stream = got.stream(tarball)\nunpackStream.remote(stream, './tmp')\n .then(index =>\n Promise.all(\n Object.keys(index)\n .map(filename =>\n index[filename].generatingIntegrity.then(integrity => ({filename, integrity})))\n )\n )\n .then(files => console.log(files))\n //> [ { filename: 'package.json',\n // integrity: 'sha512-RA0APKvtxz85WYCFX3M/TkVeJZZBcylEwh+GrV7uO/NNJO4G3rzgTrpsypp9AU2hM2QBk9SxCHi1Gb9aaWzpYg==' },\n // { filename: 'index.js',\n // integrity: 'sha512-3dL1OHn8VWhVDT37f3ZBdou4NrYq2ll//W1lWqx7+4tKBW/WqUx3mDcGyqrBfBeWTIPCd+RiUdF7hp3MQYB9+g==' },\n // { filename: 'license',\n // integrity: 'sha512-lSw93JVg7wfwyVXKrg6yIFjF9Bidgr+tA/l6XNlrRhjnE6NhwkyPL3xNL47OZScS8qoQkYUwE6slmo7jGesH0Q==' },\n // { filename: 'readme.md',\n // integrity: 'sha512-fM882axp7XaC6nzj5XYuzB0KhYpYwwsR3RjyiqOcIrI6C0b9KxrEEug9VpKTfbSbqTOmZ2KEqZLPKrMXFW1Y+g==' } ]\n```\n\n\n## API\n\n### `remote(stream, destination, [opts]): Promise<Index>`\n\nUnpacks a remote stream fetched via HTTP.\n\n**Arguments:**\n\n- `stream` - _Stream_\n- `destination` - _string_ - the directory to which the stream will be unpacked\n- `[opts.shasum]` - _string_ - shasum to verify tarball\n- `[opts.onStart]` - _Function_ - called on download start\n- `[opts.onProgress]` - _(downloaded, size) => void_ - tracks the download progress\n- `[opts.generateIntegrity]` - _Boolean_ - `true` by default. If `true`, generates [Subresource Integrity](https://w3c.github.io/webappsec-subresource-integrity/) for each unpacked file\n- `[opts.ignore]` - `(filename: string) => boolean` - a function that decides whether a file should be unpacked from the tarball.\n\n### `local(stream, destination, [opts]): Promise<Index>`\n\nUnpacks a stream from the local filesystem.\n\n**Arguments:**\n\n- `[opts.generateIntegrity]` - _Boolean_ - `true` by default. If `true`, generates [Subresource Integrity](https://w3c.github.io/webappsec-subresource-integrity/) for each unpacked file\n- `[opts.ignore]` - `(filename: string) => boolean` - a function that decides whether a file should be unpacked from the tarball.\n\n## License\n\n[MIT](./LICENSE) © [Zoltan Kochan](https://www.kochan.io)\n", "readmeFilename": "README.md", "repository": { "type": "git", "url": "git+https://github.com/zkochan/unpack-stream.git" }, "scripts": { "md": "preview && mos README.md", "prepublishOnly": "npm run tsc", "pretest": "rimraf test/dest", "test": "npm run tsc && preview && ts-node test --type-check", "tsc": "rimraf dist && tsc" }, "typings": "dist/index.d.ts", "version": "4.0.0" }