@alienkarma/archiver 7.0.1-fork.1

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2014 Chris Talkington, contributors.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,89 @@
+# Archiver
+
+A streaming interface for archive generation
+
+Visit the [API documentation](https://www.archiverjs.com/) for a list of all methods available.
+
+## Install
+
+```bash
+npm install archiver --save
+```
+
+## Quick Start
+
+```js
+import fs from "fs";
+import { ZipArchive } from "archiver";
+
+// create a file to stream archive data to.
+const output = fs.createWriteStream(__dirname + "/example.zip");
+const archive = new ZipArchive({
+  zlib: { level: 9 }, // Sets the compression level.
+});
+
+// listen for all archive data to be written
+// 'close' event is fired only when a file descriptor is involved
+output.on("close", function () {
+  console.log(archive.pointer() + " total bytes");
+  console.log(
+    "archiver has been finalized and the output file descriptor has closed.",
+  );
+});
+
+// This event is fired when the data source is drained no matter what was the data source.
+// It is not part of this library but rather from the NodeJS Stream API.
+// @see: https://nodejs.org/api/stream.html#stream_event_end
+output.on("end", function () {
+  console.log("Data has been drained");
+});
+
+// good practice to catch warnings (ie stat failures and other non-blocking errors)
+archive.on("warning", function (err) {
+  if (err.code === "ENOENT") {
+    // log warning
+  } else {
+    // throw error
+    throw err;
+  }
+});
+
+// good practice to catch this error explicitly
+archive.on("error", function (err) {
+  throw err;
+});
+
+// pipe archive data to the file
+archive.pipe(output);
+
+// append a file from stream
+const file1 = __dirname + "/file1.txt";
+archive.append(fs.createReadStream(file1), { name: "file1.txt" });
+
+// append a file from string
+archive.append("string cheese!", { name: "file2.txt" });
+
+// append a file from buffer
+const buffer3 = Buffer.from("buff it!");
+archive.append(buffer3, { name: "file3.txt" });
+
+// append a file
+archive.file("file1.txt", { name: "file4.txt" });
+
+// append files from a sub-directory and naming it `new-subdir` within the archive
+archive.directory("subdir/", "new-subdir");
+
+// append files from a sub-directory, putting its contents at the root of archive
+archive.directory("subdir/", false);
+
+// append files from a glob pattern
+archive.glob("file*.txt", { cwd: __dirname });
+
+// finalize the archive (ie we are done appending files but streams have to finish yet)
+// 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
+archive.finalize();
+```
+
+## Formats
+
+Archiver ships with out of the box support for TAR and ZIP archives.

package/index.js

@@ -0,0 +1,39 @@
+import Archiver from "./lib/core.js";
+import Zip from "./lib/plugins/zip.js";
+import Tar from "./lib/plugins/tar.js";
+import Json from "./lib/plugins/json.js";
+
+export { Archiver };
+
+export class ZipArchive extends Archiver {
+  constructor(options) {
+    super(options);
+    this._format = "zip";
+    this._module = new Zip(options);
+    this._supportsDirectory = true;
+    this._supportsSymlink = true;
+    this._modulePipe();
+  }
+}
+
+export class TarArchive extends Archiver {
+  constructor(options) {
+    super(options);
+    this._format = "tar";
+    this._module = new Tar(options);
+    this._supportsDirectory = true;
+    this._supportsSymlink = true;
+    this._modulePipe();
+  }
+}
+
+export class JsonArchive extends Archiver {
+  constructor(options) {
+    super(options);
+    this._format = "json";
+    this._module = new Json(options);
+    this._supportsDirectory = true;
+    this._supportsSymlink = true;
+    this._modulePipe();
+  }
+}