exarch-rs 0.4.0 → 0.5.0

package/README.md

@@ -161,6 +161,34 @@ interface ExtractionReport {
 }
 ```
 
+### `extractArchiveWithProgress(archivePath, outputDir, config?, progress?)`
+
+Async extraction with an optional progress callback.
+
+```typescript
+import { extractArchiveWithProgress } from 'exarch-rs';
+
+const result = await extractArchiveWithProgress(
+  'archive.tar.gz',
+  '/output/path',
+  undefined,  // SecurityConfig or undefined
+  (path, total, current, bytesWritten) => {
+    console.log(`[${current}/${total}] ${path} (${bytesWritten} bytes)`);
+  }
+);
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+|------|------|-------------|
+| `archivePath` | `string` | Path to the archive file |
+| `outputDir` | `string` | Directory where files will be extracted |
+| `config` | `SecurityConfig \| undefined` | Optional security configuration |
+| `progress` | `(path: string, total: bigint, current: bigint, bytesWritten: bigint) => void \| undefined` | Optional progress callback |
+
+**Returns:** `Promise<ExtractionReport>`
+
 ### `SecurityConfig`
 
 Builder-style security configuration.
@@ -176,6 +204,8 @@ const config = new SecurityConfig()
   .setAllowSolidArchives(true);              // Allow solid 7z archives (default: false)
 ```
 
+**Getters:** `allowSymlinks`, `allowHardlinks`, `allowAbsolutePaths`, `allowWorldWritable`, `allowSolidArchives` — each returns the corresponding boolean policy value.
+
 ## Security Features
 
 The library provides built-in protection against:
@@ -205,8 +235,6 @@ The library provides built-in protection against:
 
 **Note:** 7z creation is not yet supported. Solid and encrypted 7z archives are rejected for security reasons. Unix symlinks inside 7z archives are reported as regular files (sevenz-rust2 API limitation).
 
-**Note:** Since v0.4.0, partial extraction failures return the `ExtractionReport` accumulated up to the failure point without the inner error text being duplicated, and the report is now correctly delivered across the FFI boundary instead of being dropped early.
-
 ## Comparison with tar-fs
 
 ```javascript