Docs: Improve simple use example [improve]

overlookmotel · Apr 30, 2023 · 4107854 · 4107854
1 parent d9fbf04
commit 4107854
Showing 1 changed file with 13 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -16,17 +16,25 @@ npm install yauzl-promise
 
 ### Simple usage
 
+Unzip all files from ZIP to a directory:
+
 ```js
-const {pipeline} = require('stream/promises');
+const fs = require('fs'),
+  {pipeline} = require('stream/promises');
+
 const zipFile = await yauzl.open('/path/to/file.zip');
 try {
   for await (const entry of zipFile) {
-    if (entry.fileName.endsWith('/')) continue;
-    const readStream = await entry.openReadStream();
-    await pipeline(readStream, writeStream);
+    if (entry.fileName.endsWith('/')) {
+      await fs.promises.mkdir(`/path/to/output/${entry.fileName}`);
+    } else {
+      const readStream = await entry.openReadStream();
+      const writeStream = fs.createWriteStream(`/path/to/output/${entry.fileName}`);
+      await pipeline(readStream, writeStream);
+    }
   }
 } finally {
-  await zipfile.close();
+  await zipFile.close();
 }
 ```