Docs fixes for penumbra.saveZip() (#160)

Author: eligrey

README.md

@@ -235,12 +235,12 @@ interface PenumbraZipWriter extends EventTarget {
 }
 
 type ZipProgressDetails = {
-  /** Percentage completed */
-  percent: number;
-  /** Total bytes read */
-  totalBytesRead: number;
-  /** Total number of bytes to read */
-  contentLength: number;
+  /** Percentage completed. `null` indicates indetermination */
+  percent: number | null;
+  /** The number of bytes or items written so far */
+  written: number;
+  /** The total number of bytes or items to write. `null` indicates indetermination */
+  size: number | null;
 };
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transcend-io/penumbra",
-  "version": "4.17.1",
+  "version": "4.17.2",
   "description": "Crypto streams for the browser.",
   "main": "build/penumbra.js",
   "types": "ts-build/src/index.d.ts",

src/API.ts

@@ -143,7 +143,7 @@ const DEFAULT_MIME_TYPE = 'application/octet-stream';
 const MAX_ALLOWED_SIZE_MAIN_THREAD = 16 * 1024 * 1024; // 16 MiB
 
 /**
- * Zip files retrieved by Penumbra
+ * Save a zip containing files retrieved by Penumbra
  *
  * @param options - ZipOptions
  * @returns PenumbraZipWriter class instance

src/types.ts

@@ -127,11 +127,11 @@ export type ProgressEmit = CustomEvent<ProgressDetails>;
  * Zip progress event details
  */
 export type ZipProgressDetails = {
-  /** Percentage completed */
+  /** Percentage completed. `null` indicates indetermination */
   percent: number | null;
-  /** Total items written */
+  /** The number of bytes or items written so far */
   written: number;
-  /** Total number of expected items to write */
+  /** The total number of bytes or items to write. `null` indicates indetermination */
   size: number | null;
 };
 

src/utils/emitZipProgress.ts

@@ -5,8 +5,8 @@ import { PenumbraEvent } from '../event';
 /**
  * An event emitter for PenumbraZipWriter progress
  * @param writer - PenumbraZipWriter instance
- * @param totalBytesRead - The number of bytes or items written so far
- * @param contentLength - The total number of bytes or items to write
+ * @param written - The number of bytes or items written so far
+ * @param size - The total number of bytes or items to write
  * @returns
  */
 export default function emitZipProgress(

src/zip.ts

@@ -28,7 +28,13 @@ const sumWrites = async (writes: Promise<number>[]): Promise<number> => {
   );
 };
 
-/** Wrapped WritableStream for state keeping with StreamSaver */
+/**
+ * Save a zip containing files retrieved by Penumbra
+ *
+ * @example new PenumbraZipWriter(options)
+ * @param options - ZipOptions
+ * @returns PenumbraZipWriter class instance
+ */
 export class PenumbraZipWriter extends EventTarget {
   /** Conflux zip writer instance */
   private conflux: Writer = new Writer();