docs: Add symbol documentation to existing interfaces

Author: zhangfuxing

README.md

@@ -20,7 +20,7 @@ If you want to read and write files, you need the following [permissions](https:
 
 ### Definition
 
-v0.5.1
+v0.5.2
 Use `@std/tar` instead of `@std/archive` due to deprecation
 If you want to use the old API, you can do it
 > import { tar } from "jsr:@deno-library/compress/tar_archive/mod.ts";
@@ -29,11 +29,11 @@ If you want to use the old API, you can do it
 // JSR
 import { tar } from "jsr:@deno-library/compress";
 // or
-// import { tar } from "jsr:@deno-library/[email protected].1";
+// import { tar } from "jsr:@deno-library/[email protected].2";
 // or
-// import { tar } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { tar } from "https://deno.land/x/[email protected].2/mod.ts";
 // or only import tar
-// import { tar } from "https://deno.land/x/[email protected].1/tar/mod.ts";
+// import { tar } from "https://deno.land/x/[email protected].2/tar/mod.ts";
 export interface compressInterface {
   excludeSrc?: boolean;      // does not contain the src directory
   debug?: boolean;           // list the files and folders
@@ -51,7 +51,7 @@ tar.uncompress(src, dest, options?: uncompressInterface): Promise<void>;
 // JSR
 import { tar } from "jsr:@deno-library/compress";
 // or
-// import { tar } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { tar } from "https://deno.land/x/[email protected].2/mod.ts";
 // compress folder
 await tar.compress("./test", "./test.tar");
 // compress folder, exclude src directory
@@ -78,9 +78,9 @@ import {
   inflateRaw,
 } from "jsr:@deno-library/compress";
 // or
-// import { deflate, inflate, deflateRaw, inflateRaw } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { deflate, inflate, deflateRaw, inflateRaw } from "https://deno.land/x/[email protected].2/mod.ts";
 // or only import deflate, inflate, deflateRaw, inflateRaw
-// import { deflate, inflate, deflateRaw, inflateRaw } from "https://deno.land/x/[email protected].1/zlib/mod.ts";
+// import { deflate, inflate, deflateRaw, inflateRaw } from "https://deno.land/x/[email protected].2/zlib/mod.ts";
 const str = "hello world!";
 const bytes = new TextEncoder().encode(str);
 // with zlib header
@@ -123,9 +123,9 @@ Useful for reading and writing large files.
 ```ts
 import { GzipStream } from "jsr:@deno-library/compress";
 // or
-// import { GzipStream } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { GzipStream } from "https://deno.land/x/[email protected].2/mod.ts";
 // or only import GzipStream
-// import { GzipStream } from "https://deno.land/x/[email protected].1/gzip/mod.ts";
+// import { GzipStream } from "https://deno.land/x/[email protected].2/gzip/mod.ts";
 const gzip = new GzipStream();
 gzip.on("progress", (progress: string) => {
   console.log(progress); // 0.00% => 100.00%
@@ -140,9 +140,9 @@ await gzip.uncompress("./big.mkv.gz", "./big.mkv");
 ```ts
 import { gunzipFile, gzipFile } from "jsr:@deno-library/compress";
 // or
-// import { gunzipFile, gzipFile } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { gunzipFile, gzipFile } from "https://deno.land/x/[email protected].2/mod.ts";
 // or only import gzipFile, gunzipFile
-// import { gzipFile, gunzipFile } from "https://deno.land/x/[email protected].1/gzip/mod.ts";
+// import { gzipFile, gunzipFile } from "https://deno.land/x/[email protected].2/gzip/mod.ts";
 await gzipFile("./deno.txt", "./deno.txt.gz");
 await gunzipFile("./deno.txt.gz", "./deno.txt");
 ```
@@ -155,9 +155,9 @@ await gunzipFile("./deno.txt.gz", "./deno.txt");
 ```ts
 import { gunzip, gzip } from "jsr:@deno-library/compress";
 // or
-// import { gunzip, gzip } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { gunzip, gzip } from "https://deno.land/x/[email protected].2/mod.ts";
 // or only import gzip, gunzip
-// import { gzip, gunzip } from "https://deno.land/x/[email protected].1/zlib/mod.ts";
+// import { gzip, gunzip } from "https://deno.land/x/[email protected].2/zlib/mod.ts";
 // gzip
 const bytes = new TextEncoder().encode("hello");
 const compressed = gzip(bytes);
@@ -167,7 +167,7 @@ const decompressed = gunzip(compressed);
 
 ## `tgz`
 
-v0.5.1
+v0.5.2
 Use `@std/tar` instead of `@std/archive` due to deprecation
 If you want to use the old API, you can do it
 > import { tgz } from "jsr:@deno-library/compress/tgz_archive/mod.ts";
@@ -177,9 +177,9 @@ If you want to use the old API, you can do it
 ```ts
 import { tgz } from "jsr:@deno-library/compress";
 // or
-// import { tgz } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { tgz } from "https://deno.land/x/[email protected].2/mod.ts";
 // or only import tgz
-// import { tgz } from "https://deno.land/x/[email protected].1/tgz/mod.ts";
+// import { tgz } from "https://deno.land/x/[email protected].2/tgz/mod.ts";
 export interface compressInterface {
   excludeSrc?: boolean;      // does not contain the src directory
   debug?: boolean;           // list the files and folders
@@ -196,7 +196,7 @@ tgz.uncompress(src, dest, options?: uncompressInterface): Promise<void>;
 ```ts
 import { tgz } from "jsr:@deno-library/compress";
 // or
-// import { tgz } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { tgz } from "https://deno.land/x/[email protected].2/mod.ts";
 // compress folder
 await tgz.compress("./test", "./test.tar.gz");
 // compress folder, exclude src directory
@@ -214,9 +214,9 @@ await tgz.uncompress("./test.tar.gz", "./dest");
 ```ts
 import { zip } from "jsr:@deno-library/compress";
 // or
-// import { zip } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { zip } from "https://deno.land/x/[email protected].2/mod.ts";
 // or only import zip
-// import { zip } from "https://deno.land/x/[email protected].1/zip/mod.ts";
+// import { zip } from "https://deno.land/x/[email protected].2/zip/mod.ts";
 
 export interface compressInterface {
   excludeSrc?: boolean;      // does not contain the src directory
@@ -234,7 +234,7 @@ zip.uncompress(src, dest, options?: uncompressInterface): Promise<void>;
 ```ts
 import { zip } from "jsr:@deno-library/compress";
 // or
-// import { zip } from "https://deno.land/x/[email protected].1/mod.ts";
+// import { zip } from "https://deno.land/x/[email protected].2/mod.ts";
 // compress folder
 await zip.compress("./test", "./test.tar.gz");
 // compress folder, exclude src directory

changelog.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+### v0.5.2 - 2024.11.6
+
+- docs: Add symbol documentation to existing interfaces
+
 ### v0.5.1 - 2024.11.6
 
 - refactor(zip): Use `zip-js` instead of using a terminal

interface.ts

@@ -1,8 +1,43 @@
+/**
+ * Configuration interface for compression operations.
+ *
+ * @interface compressInterface
+ */
 export interface compressInterface {
-  excludeSrc?: boolean; // does not contain the src directory
-  debug?: boolean; // list the files and folders
+  /**
+   * Specifies whether to exclude the source directory from the compression.
+   * If set to true, the `src` directory will not be included in the compressed output.
+   * By default, the `src` directory is included.
+   *
+   * @type {boolean}
+   * @memberof compressInterface
+   */
+  excludeSrc?: boolean;
+
+  /**
+   * Specifies whether to enable debug mode.
+   * In debug mode, all files and folders being processed will be listed.
+   * By default, no such information is displayed.
+   *
+   * @type {boolean}
+   * @memberof compressInterface
+   */
+  debug?: boolean;
 }
 
+/**
+ * Configuration interface for uncompression (decompression) operations.
+ *
+ * @interface uncompressInterface
+ */
 export interface uncompressInterface {
-  debug?: boolean; // list the files and folders
-}
+  /**
+   * Specifies whether to enable debug mode.
+   * In debug mode, all files and folders being processed will be listed.
+   * By default, no such information is displayed.
+   *
+   * @type {boolean}
+   * @memberof uncompressInterface
+   */
+  debug?: boolean;
+}

zip_archive/archive.ts

@@ -35,6 +35,12 @@ export async function uncompress(
   }
 }
 
+/**
+ * Compresses a file.
+ * @param {string} src - Source file path.
+ * @param {string} dest - Destination file path.
+ * @param {compressInterface} [options] - Optional parameters.
+ */
 export async function compress(
   src: string,
   dest: string,

zlib/deflate.ts

@@ -22,6 +22,9 @@ export interface DeflateOptions {
   header?: zlibDeflate.Header; // Custom header
 }
 
+/**
+ * Required Options for the Deflate class.
+ */
 interface DeflateOptionsRequired {
   level: number;
   method: number;