feat: allow null value for schedulingStrategy in FinderOptions and update documentation accordingly.

Author: Sec-ant

.changeset/small-houses-fix.md

@@ -0,0 +1,5 @@
+---
+"@sec-ant/finder": minor
+---
+
+Update schedulingStrategy option to allow null value in FinderOptions.

README.md

@@ -106,7 +106,7 @@ Maximum number of path checks before attempting to generate a selector. Defaults
 
 ### schedulingStrategy
 
-Defines the scheduling strategy for yielding control to the main thread during selector generation. This helps prevent the page from becoming unresponsive during intensive computations. Possible values are `'interactive'`, `'smooth'`, or `'idle'`. Defaults to `'idle'`.
+Defines the scheduling strategy for yielding control to the main thread during selector generation. This helps prevent the page from becoming unresponsive during intensive computations. Possible values are `'interactive'`, `'smooth'`, `'idle'`, or `null`. Defaults to `'idle'`. If `null` is provided, the scheduling strategy will be disabled, and no yielding to the main thread will occur.
 
 ### abortSignal
 

src/index.ts

@@ -108,7 +108,7 @@ export interface FinderOptions {
   /** Maximum number of path checks. */
   maxNumberOfPathChecks?: number;
   /** The scheduling strategy for yielding control to the main thread. */
-  schedulingStrategy?: SchedulingStrategy;
+  schedulingStrategy?: SchedulingStrategy | null;
   /** An AbortSignal to allow aborting the operation. */
   abortSignal?: AbortSignal;
 }
@@ -150,7 +150,7 @@ export async function finder(
 
   const startTime = new Date();
   const config: ResolvedFinderOptions = { ...defaultOptions, ...options };
-  const rootDocument = findRootDocument(config.root, defaultOptions); // Cast to satisfy findRootDocument
+  const rootDocument = findRootDocument(config.root, defaultOptions);
 
   let foundPath: Knot[] | undefined;
   let count = 0;
@@ -163,7 +163,9 @@ export async function finder(
     }
     const candidate = iteratorResult.value;
 
-    await yieldOrContinue(config.schedulingStrategy, config.abortSignal);
+    if (config.schedulingStrategy) {
+      await yieldOrContinue(config.schedulingStrategy, config.abortSignal);
+    }
 
     const elapsedTimeMs = new Date().getTime() - startTime.getTime();
     if (
@@ -205,7 +207,9 @@ export async function finder(
     }
     const currentOptimizedPath = iteratorResult.value;
     optimizedPaths.push(currentOptimizedPath);
-    await yieldOrContinue(config.schedulingStrategy, config.abortSignal);
+    if (config.schedulingStrategy) {
+      await yieldOrContinue(config.schedulingStrategy, config.abortSignal);
+    }
   }
 
   if (optimizedPaths.length > 0) {

tests/finder.test.ts

@@ -15,7 +15,7 @@ async function check(
 ) {
   document.documentElement.innerHTML = html;
 
-  const options = {
+  const options: FinderOptions = {
     timeoutMs: Number.POSITIVE_INFINITY,
     maxNumberOfPathChecks: 2_000,
     ...finderOptions,