ares-ide
Version:
A browser-based code editor and UI designer for Enyo 2 projects
57 lines (56 loc) • 4.68 kB
JSON
{
"name": "archiver",
"version": "0.4.10",
"description": "Creates Archives (ZIP) via Node Streams.",
"homepage": "https://github.com/ctalkington/node-archiver",
"author": {
"name": "Chris Talkington",
"url": "http://christalkington.com/"
},
"repository": {
"type": "git",
"url": "https://github.com/ctalkington/node-archiver.git"
},
"bugs": {
"url": "https://github.com/ctalkington/node-archiver/issues"
},
"licenses": [
{
"type": "MIT",
"url": "https://github.com/ctalkington/node-archiver/blob/master/LICENSE-MIT"
}
],
"main": "lib/archiver.js",
"engines": {
"node": ">= 0.6.3"
},
"scripts": {
"test": "mocha --reporter dot",
"bench": "node benchmark/simple/pack-zip.js"
},
"dependencies": {
"readable-stream": "~1.0.2",
"iconv-lite": "~0.2.11"
},
"devDependencies": {
"chai": "~1.7.1",
"mocha": "~1.12.0",
"rimraf": "~2.2.0",
"mkdirp": "~0.3.5",
"stream-bench": "~0.1.2"
},
"keywords": [
"archive",
"archiver",
"zip",
"tar"
],
"readme": "# Archiver v0.4.10 [](http://travis-ci.org/ctalkington/node-archiver)\r\n\r\nCreates Archives (Zip, Tar) via Node Streams. Depends on Node's built-in zlib module for compression available since version 0.6.3.\r\n\r\n## Install\r\n\r\n```bash\r\nnpm install archiver --save\r\n```\r\n\r\nYou can also use `npm install https://github.com/ctalkington/node-archiver/archive/master.tar.gz` to test upcoming versions.\r\n\r\n## Archiver\r\n\r\n#### #create(type, options)\r\n\r\nCreates an Archiver instance based on the type (ie zip/tar) passed. Can be passed to `Archiver` for convenience.\r\n\r\n### Instance Methods\r\n\r\n#### #append(input, data, callback(err))\r\n\r\nAppends a file to the instance. Input can be in the form of a text string, buffer, or stream. When the instance has received, processed, and emitted the input, the callback is fired.\r\n\r\nReplaces `#addFile` which is in the depreciation stage and set to be remove in next release.\r\n\r\n#### #finalize(callback(err, bytes))\r\n\r\nFinalizes the instance. When the instance's stream has finished emitting, the callback is fired. This generally doesn't correspond to the end of the destination stream; though a solution to track the destination stream may come in a future release.\r\n\r\n## Zip\r\n\r\n### Options\r\n\r\n#### comment `string`\r\n\r\nSets the zip comment.\r\n\r\n#### forceUTC `boolean`\r\n\r\nIf true, forces the file date and time to UTC. Helps with testing across timezones.\r\n\r\n#### zlib `object`\r\n\r\nPassed to node's [zlib](http://nodejs.org/api/zlib.html#zlib_options) module to control compression. Options may vary by node version.\r\n\r\n### File Data\r\n\r\n#### name `string` `required`\r\n\r\nSets the file name including internal path.\r\n\r\n#### date `string|Date`\r\n\r\nSets the file date. This can be any valid date string or instance. Defaults to current time in locale.\r\n\r\n#### store `boolean`\r\n\r\nIf true, file contents will be stored without compression.\r\n\r\n#### comment `string`\r\n\r\nSets the file comment.\r\n\r\n## Tar\r\n\r\n### Options\r\n\r\n#### recordSize `number`\r\n\r\nSets the size (in bytes) of each record in a block, default is 512 (for advanced users only).\r\n\r\n#### recordsPerBlock `number`\r\n\r\nSets the number of records in a block, default is 20 (for advanced users only).\r\n\r\n### File Data\r\n\r\n#### name `string` `required`\r\n\r\nSets the file name including internal path.\r\n\r\n#### date `string|Date`\r\n\r\nSets the file date. This can be any valid date string or instance. Defaults to current time in locale.\r\n\r\n## Things of Interest\r\n\r\n- [Examples](https://github.com/ctalkington/node-archiver/blob/master/examples)\r\n- [Changelog](https://github.com/ctalkington/node-archiver/blob/master/CHANGELOG)\r\n- [Archive Formats](https://github.com/ctalkington/node-archiver/blob/master/formats)\r\n- [Contributing](https://github.com/ctalkington/node-archiver/blob/master/CONTRIBUTING.md)\r\n- [MIT License](https://github.com/ctalkington/node-archiver/blob/master/LICENSE-MIT)\r\n\r\n## Credits\r\n\r\nConcept inspired by Antoine van Wel's [node-zipstream](https://github.com/wellawaretech/node-zipstream).\r\n\r\nTar inspired by isaacs's [node-tar](https://github.com/isaacs/node-tar).\r\n",
"readmeFilename": "README.md",
"_id": "archiver@0.4.10",
"dist": {
"shasum": "e14a017cf3303a3fea4612c471e1771e1195c2ec"
},
"_from": "archiver@0.4.10",
"_resolved": "https://registry.npmjs.org/archiver/-/archiver-0.4.10.tgz"
}