fix: resolve TypeScript errors in documentation examples and improve type handling

- Add null checks in documentation examples for getTweetInfo and link
- Fix signal variable name in WebSocket listen example
- Improve type handling in pin.ts changes array
- Update type annotations in documentation examples

Author: devin-ai-integration[bot]

browser/dom/cache.ts

@@ -2,7 +2,7 @@
  *
  * This function searches through the cache storage in reverse chronological order
  * to find the most recent cached response for a given request.
- * 
+ *
  * > [!Note]
  * > Implementation inspired by Scrapbox's ServiceWorker and Cache usage pattern.
  *

browser/dom/caret.ts

@@ -1,7 +1,7 @@
 import { textInput } from "./dom.ts";
 
 /** Position information within the editor
- * 
+ *
  * @see {@linkcode Range} for selection range information
  */
 export interface Position {
@@ -12,7 +12,7 @@ export interface Position {
 /** Represents a text selection range in the editor
  *
  * When no text is selected, {@linkcode start} and {@linkcode end} positions are the same (cursor position)
- * 
+ *
  * @see {@linkcode Position} for position type details
  */
 export interface Range {

browser/dom/cursor.d.ts

@@ -17,7 +17,7 @@ export interface SetPositionOptions {
 }
 
 /** Class for managing cursor operations in the Scrapbox editor
- * 
+ *
  * @see {@linkcode Position} for cursor position type details
  * @see {@linkcode Page} for page data type details
  */

browser/websocket/findMetadata.test.ts

@@ -42,15 +42,17 @@ Prepare thumbnail
 Deno.test({
   name: "findMetadata()",
   ignore: true,
-  fn: (t) => assertSnapshot(t, findMetadata(text))
+  fn: (t) => assertSnapshot(t, findMetadata(text)),
 });
 
 // Test Helpfeel extraction (lines starting with "?")
 // These are used for collecting questions and help requests in Scrapbox
 Deno.test({
   name: "getHelpfeels()",
   ignore: true,
-  fn: () =>
-  assertEquals(getHelpfeels(text.split("\n").map((text) => ({ text }))), [
-    "Help needed with setup!!",
-  ]));
+  fn: () => {
+    assertEquals(getHelpfeels(text.split("\n").map((text) => ({ text }))), [
+      "Help needed with setup!!",
+    ]);
+  },
+});

browser/websocket/listen.ts

@@ -42,9 +42,9 @@ export type ListenStreamError =
  *
  * Example:
  * ```ts
- * listen(socket, "project:update", (data) => {
+ * listen(socket, "project:update", (data: ProjectUpdateData) => {
  *   console.log("Project updated:", data);
- * }, { signal: abortController.signal });
+ * }, { signal: controller.signal });
  * ```
  */
 export const listen = <EventName extends keyof ListenEvents>(

browser/websocket/pin.ts

@@ -43,7 +43,8 @@ export const pin = (
       ) return [];
       // Create page and pin it in a single operation
       // Note: The server accepts combined creation and pin operations
-      const changes: Change[] = [{ pin: pinNumber() }] as Change[];
+      const pinChange: Change = { pin: pinNumber() };
+      const changes: Change[] = [pinChange];
       if (!page.persistent) changes.unshift({ title });
       return changes;
     },

rest/getTweetInfo.ts

@@ -51,7 +51,9 @@ export type TweetInfoError =
  *   return;
  * }
  * const tweetInfo = result.val;
- * console.log("Tweet text:", tweetInfo.text);
+ * if (tweetInfo) {
+ *   console.log("Tweet text:", tweetInfo.text);
+ * }
  * ```
  *
  * Note: The function includes a 3000ms timeout for the API request.

rest/link.ts

@@ -170,7 +170,9 @@ export const getLinks: GetLinks = /* @__PURE__ */ (() => {
  *     break;
  *   }
  *   const links = result.val; // Array of links in this batch
- *   console.log(`Got ${links.length} links`);
+ *   if (links) {
+ *     console.log(`Got ${links.length} links`);
+ *   }
  * }
  * ```
  */
@@ -216,7 +218,9 @@ export async function* readLinksBulk(
  *     break;
  *   }
  *   const link = result.val; // Single link entry
- *   console.log("Processing link:", link.title);
+ *   if (link) {
+ *     console.log("Processing link:", link.title);
+ *   }
  * }
  * ```
  */