tar-vern 0.3.0 → 1.1.0

package/README_pack.md

@@ -2,7 +2,7 @@
 
 Tape archiver (tar) library for Typescript implementation.
 
-[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ----
@@ -27,15 +27,15 @@ npm install tar-vern
 
 ----
 
-## Usage for tar packing
-
-### Minimum example
+## Minimal sample code
 
 tar-vern supplies file and directory information to pack through "TypeScript async generator."
 This allows you to specify pack data with very concise code.
 
 ```typescript
-import { createTarPacker, storeReaderToFile } from 'tar-vern';
+import {
+  createTarPacker, storeReaderToFile,
+  createFileItem, createDirectoryItem } from 'tar-vern';
 
 // Create an async generator for tar entries
 const itemGenerator = async function*() {
@@ -51,13 +51,47 @@ const itemGenerator = async function*() {
   // (Make your own entries with yield expression...)
 };
 
-// Create GZip compressed tar stream
+// Create GZipped tar stream and write to file
 const packer = createTarPacker(itemGenerator(), 'gzip');
 await storeReaderToFile(packer, 'archive.tar.gz');   // Use helper to awaitable
 ```
 
+tar-vern provides tar extraction through async generator too, allowing you to process entries as they are extracted from the tar archive.
+
+```typescript
+import { createReadStream } from 'fs';
+import { createTarExtractor } from 'tar-vern';
+
+// Read GZipped tar file and extract entries
+const readableStream = createReadStream('archive.tar.gz');
+
+for await (const extractedItem of createTarExtractor(readableStream), 'gzip') {
+  if (extractedItem.kind === 'file') {
+    console.log(`File: ${extractedItem.path}`);
+    
+    // Get content as string or buffer
+    const content = await extractedItem.getContent('string');
+    console.log(`Content: ${content}`);
+  } else {
+    console.log(`Directory: ${extractedItem.path}`);
+  }
+}
+```
+
 ----
 
+## Features
+
+- Bidirectional streaming: Both creation and extraction of tar archives
+- Memory-efficient: Streaming API for processing large files without content buffering
+- Multiple content sources: String, Buffer, ReadableStream, file paths and async generators
+- Metadata preservation: File permissions, ownership, timestamps
+- Built-in compression/decompression: GZip compression support (`tar.gz` format)
+- Flexible content access: Extract files as string, Buffer, or Readable stream on demand
+- Error handling: Comprehensive validation and error reporting
+- Abort signal support: Cancellable operations
+- No external dependencies: Pure TypeScript implementation
+
 For more information, [see repository documents](http://github.com/kekyo/tar-vern/).
 
 ----

package/dist/extractor.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * name: tar-vern
+ * version: 1.1.0
+ * description: Tape archiver library for Typescript
+ * author: Kouji Matsui (@kekyo@mi.kekyo.net)
+ * license: MIT
+ * repository.url: https://github.com/kekyo/tar-vern.git
+ * git.commit.hash: 6d4ff13b538b16545ccc55b2e74f8e5f73999a34
+ */
+
+import { Readable } from 'stream';
+import { CompressionTypes, ExtractedEntryItem } from './types';
+/**
+ * Create a tar extractor
+ * @param readable - The readable stream containing tar data
+ * @param compressionType - The compression type (default: 'none')
+ * @param signal - The abort signal
+ * @returns Async generator of entry items
+ */
+export declare const createTarExtractor: (readable: Readable, compressionType?: CompressionTypes, signal?: AbortSignal) => AsyncGenerator<ExtractedEntryItem, void, unknown>;
+//# sourceMappingURL=extractor.d.ts.map

package/dist/extractor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractor.d.ts","sourceRoot":"","sources":["../src/extractor.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,gBAAgB,EAA0B,kBAAkB,EAAqB,MAAM,SAAS,CAAC;AAmS1G;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,UAAU,QAAQ,EAClB,kBAAkB,gBAAgB,EAClC,SAAS,WAAW,KAAG,cAAc,CAAC,kBAAkB,EAAE,IAAI,EAAE,OAAO,CAyIxE,CAAC"}