docs: document symbols

deno.json

@@ -1,12 +1,23 @@
 {
   "name": "@mumulhl/duckduckgo-ai-chat",
   "version": "2.0.1",
-  "exports": "./mod.ts"
+  "exports": "./mod.ts",
   "tasks": {
-    "dev": "deno run --watch main.ts"
+    "test": "deno run -A test.ts",
   },
   "imports": {
     "@lukeed/fetch-event-stream": "jsr:@lukeed/fetch-event-stream@^0.1.5",
-    "@std/assert": "jsr:@std/assert@1"
+    "@std/assert": "jsr:@std/assert@1",
+  },
+  "publish": {
+    "include": [
+      "LICENSE",
+      "README.md",
+      "README_CN.md",
+      "*.ts",
+    ],
+    "exclude": [
+      "test.ts",
+    ],
   }
 }

index.ts

@@ -30,7 +30,13 @@ class Chat {
     this.messages = [];
   }
 
-  async fetch(content: string) {
+  /**
+   * Fetching the original message.
+   *
+   * @param content The content to send.
+   * @returns The original message.
+   */
+  async fetch(content: string): Promise<Response> {
     this.messages.push({ content, role: "user" });
     const payload: ChatPayload = {
       model: this.model,
@@ -52,6 +58,12 @@ class Chat {
     }
   }
 
+  /**
+   * Fetching the full message.
+   *
+   * @param content The content to send.
+   * @returns The full message.
+   */
   async fetchFull(content: string): Promise<string> {
     const message = await this.fetch(content);
     let text = "";
@@ -76,6 +88,12 @@ class Chat {
     return text;
   }
 
+  /**
+   * Fetching the streaming message.
+   *
+   * @param content The content to send.
+   * @returns The streaming message.
+   */
   async *fetchStream(content: string): AsyncGenerator<string, void> {
     const message = await this.fetch(content);
     const stream = events(message);
@@ -100,13 +118,21 @@ class Chat {
     this.messages.push({ content: text, role: "assistant" });
   }
 
+  /**
+   * Redo.
+   */
   redo() {
     this.newVqd = this.oldVqd;
     this.messages.pop();
     this.messages.pop();
   }
 }
 
+/** Init chat.
+ *
+ * @param model The model used by chat.
+ * @returns A Chat instance.
+ */
 async function initChat(model: Model): Promise<Chat> {
   const status = await fetch(STATUS_URL, { headers: STATUS_HEADERS });
   const vqd = status.headers.get("x-vqd-4");

test.ts

@@ -5,7 +5,6 @@ async function test(name: string, fn: any) {
   console.log(name);
   await fn();
   console.log();
-  console.log();
 }
 
 await test("Init chat", async () => {