mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
71 lines
2.6 KiB
TypeScript
71 lines
2.6 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
|
|
/*!
|
|
* Ported and modified from: https://github.com/beatgammit/tar-js and
|
|
* licensed as:
|
|
*
|
|
* (The MIT License)
|
|
*
|
|
* Copyright (c) 2011 T. Jameson Little
|
|
* Copyright (c) 2019 Jun Kato
|
|
* Copyright (c) 2018-2024 the Deno authors
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* Tar is a utility for collecting multiple files (or any arbitrary data) into one
|
|
* archive file, while untar is the inverse utility to extract the files from an
|
|
* archive. Files are not compressed, only collected into the archive.
|
|
*
|
|
* ```ts no-eval
|
|
* import { Tar } from "@std/archive/tar";
|
|
* import { Buffer } from "@std/io/buffer";
|
|
* import { copy } from "@std/io/copy";
|
|
*
|
|
* const tar = new Tar();
|
|
*
|
|
* // Now that we've created our tar, let's add some files to it:
|
|
*
|
|
* const content = new TextEncoder().encode("Some arbitrary content");
|
|
* await tar.append("deno.txt", {
|
|
* reader: new Buffer(content),
|
|
* contentSize: content.byteLength,
|
|
* });
|
|
*
|
|
* // This file is sourced from the filesystem (and renamed in the archive)
|
|
* await tar.append("filename_in_archive.txt", {
|
|
* filePath: "./filename_on_filesystem.txt",
|
|
* });
|
|
*
|
|
* // Now let's write the tar (with it's two files) to the filesystem
|
|
* // use tar.getReader() to read the contents.
|
|
*
|
|
* const writer = await Deno.open("./out.tar", { write: true, create: true });
|
|
* await copy(tar.getReader(), writer);
|
|
* writer.close();
|
|
* ```
|
|
*
|
|
* @experimental **UNSTABLE**: New API, yet to be vetted.
|
|
*
|
|
* @module
|
|
*/
|
|
export * from "./tar.ts";
|
|
export * from "./untar.ts";
|