fix: Update the types to improve usage. (#998)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: Jason3S

jsr.json

@@ -7,15 +7,7 @@
         "./node": "./dist/index.js"
     },
     "publish": {
-        "include": [
-            "LICENSE",
-            "README.md",
-            "dist/*.d.ts",
-            "dist/browser.*",
-            "dist/index.js"
-        ],
-        "exclude": [
-            "!dist"
-        ]
+        "include": ["LICENSE", "README.md", "dist/*.d.ts", "dist/browser.*", "dist/index.js"],
+        "exclude": ["!dist"]
     }
 }

src/RegExpWorker.ts

@@ -175,6 +175,9 @@ export function timeoutRejection(e: unknown): Promise<never> {
  */
 export type RangePair = [start: number, end: number];
 
+/**
+ * Represents the result of RegExpWorker.matchAllAsRangePairs
+ */
 export interface MatchAllAsRangePairsResult {
     elapsedTimeMs: number;
     /**

src/RegExpWorkerBrowser.ts

@@ -26,6 +26,9 @@ export type {
     RangePair,
 } from './RegExpWorker.js';
 
+/**
+ * A Regular Expression Worker for browser and Deno environments. It use the Web Worker API to run RegExp operations in a separate thread.
+ */
 export class RegExpWorker extends RegExpWorkerBase {
     /**
      * Create a new RegExpWorker instance.
@@ -37,6 +40,12 @@ export class RegExpWorker extends RegExpWorkerBase {
     }
 }
 
+/**
+ * Create a new RegExpWorker instance.
+ * @param timeoutMs - Optional time limit in milliseconds for each request execution. Default is 1000ms.
+ * @param stopIdleWorkerAfterMs - Optional time in milliseconds to wait after processing the last request before stopping the worker. Default is 200ms.
+ * @returns a new instance of RegExpWorker.
+ */
 export function createRegExpWorker(timeoutMs?: number, stopIdleWorkerAfterMs?: number): RegExpWorker {
     return new RegExpWorker(timeoutMs, stopIdleWorkerAfterMs);
 }

src/RegExpWorkerNode.ts

@@ -26,6 +26,9 @@ export type {
     RangePair,
 } from './RegExpWorker.js';
 
+/**
+ * A Regular Expression Worker for NodeJS environments. It use the `node:worker_threads` Worker API to run RegExp operations in a separate thread.
+ */
 export class RegExpWorker extends RegExpWorkerBase {
     /**
      * Create a new RegExpWorker instance.
@@ -37,6 +40,12 @@ export class RegExpWorker extends RegExpWorkerBase {
     }
 }
 
+/**
+ * Create a new RegExpWorker instance.
+ * @param timeoutMs - Optional time limit in milliseconds for each request execution. Default is 1000ms.
+ * @param stopIdleWorkerAfterMs - Optional time in milliseconds to wait after processing the last request before stopping the worker. Default is 200ms.
+ * @return a new instance of RegExpWorker.
+ */
 export function createRegExpWorker(timeoutMs?: number, stopIdleWorkerAfterMs?: number): RegExpWorker {
     return new RegExpWorker(timeoutMs, stopIdleWorkerAfterMs);
 }

src/helpers/evaluateRegExp.ts

@@ -1,6 +1,9 @@
 import { measureExecution } from '../timer.js';
 import type { RegExpLike } from './regexp.js';
 
+/**
+ * Represents the result of RegExpWorker.matchAll
+ */
 export interface MatchAllRegExpResult {
     elapsedTimeMs: number;
     matches: RegExpMatchArray[];
@@ -17,6 +20,9 @@ export function matchAllRegExp(text: string, regExp: RegExp): MatchAllRegExpResu
     return { elapsedTimeMs, matches: r };
 }
 
+/**
+ * Represents the result of RegExpWorker.exec
+ */
 export interface ExecRegExpResult {
     elapsedTimeMs: number;
     lastIndex: number;
@@ -34,6 +40,9 @@ export function execRegExp(regExp: RegExp, text: string): ExecRegExpResult {
     return { elapsedTimeMs, lastIndex: regExp.lastIndex, match };
 }
 
+/**
+ * Represents the result of RegExpWorker.match
+ */
 export interface MatchRegExpResult {
     elapsedTimeMs: number;
     lastIndex: number;
@@ -51,6 +60,9 @@ export function matchRegExp(text: string, regExp: RegExp): MatchRegExpResult {
     return { elapsedTimeMs, lastIndex: regExp.lastIndex, match };
 }
 
+/**
+ * Represents the result of RegExpWorker.matchAllArray
+ */
 export interface MatchAllRegExpArrayResult {
     elapsedTimeMs: number;
     results: MatchAllRegExpResult[];

src/helpers/regexp.ts

@@ -1,5 +1,8 @@
 export type RegExpOrString = RegExp | string;
 
+/**
+ * Represents a regular expression-like object that has `source` and `flags` properties.
+ */
 export interface RegExpLike {
     source: string;
     flags: string;