☕ Add JSDoc

Author: Milly

scripts/utils.ts

@@ -1,5 +1,9 @@
 import * as streams from "https://deno.land/std@0.183.0/streams/mod.ts";
 
+/**
+ * Downloads a text file and returns the contents.
+ * Throws error if fetch fails.
+ */
 export async function downloadString(url: string): Promise<string> {
   const textDecoder = new TextDecoder();
   const response = await fetch(url);
@@ -10,24 +14,32 @@ export async function downloadString(url: string): Promise<string> {
   return textDecoder.decode(await streams.readAll(reader));
 }
 
+/**
+ * Find the position of the first pattern match.
+ * Search from the specified position, or from the beginning if not specified.
+ * Returns -1 if the pattern not match.
+ */
 export function regexIndexOf(s: string, pattern: RegExp, offset = 0): number {
   const index = s.slice(offset).search(pattern);
   return index < 0 ? index : index + offset;
 }
 
+/** Count the number of occurrences of a name. */
 export class Counter {
   #map: Map<string, number>;
 
   constructor() {
     this.#map = new Map();
   }
 
+  /** Increments the count number of the name and returns it. */
   count(name: string): number {
     const value = this.get(name) + 1;
     this.#map.set(name, value);
     return value;
   }
 
+  /** Returns the count number of the name. */
   get(name: string): number {
     return this.#map.get(name) ?? 0;
   }