@fuzdev/fuz_util 0.54.0 → 0.56.0

package/dist/process.d.ts

@@ -138,20 +138,20 @@ export declare class ProcessRegistry {
      * Spawns a process and tracks it in this registry.
      * The process is automatically unregistered when it exits.
      *
-     * @param command - The command to run
-     * @param args - Arguments to pass to the command
-     * @param options - Spawn options including `signal` and `timeout_ms`
-     * @returns Handle with `child` process and `closed` promise
+     * @param command - the command to run
+     * @param args - arguments to pass to the command
+     * @param options - spawn options including `signal` and `timeout_ms`
+     * @returns handle with `child` process and `closed` promise
      */
     spawn(command: string, args?: ReadonlyArray<string>, options?: SpawnProcessOptions): SpawnedProcess;
     /**
      * Spawns a process and captures stdout/stderr as strings.
      * Sets `stdio: 'pipe'` automatically.
      *
-     * @param command - The command to run
-     * @param args - Arguments to pass to the command
-     * @param options - Spawn options
-     * @returns Result with captured `stdout` and `stderr`.
+     * @param command - the command to run
+     * @param args - arguments to pass to the command
+     * @param options - spawn options
+     * @returns result with captured `stdout` and `stderr`
      *   - `null` means spawn failed (ENOENT, etc.) or stream was unavailable
      *   - `''` (empty string) means process ran but produced no output
      *   - non-empty string contains the captured output
@@ -160,16 +160,16 @@ export declare class ProcessRegistry {
     /**
      * Kills a child process and waits for it to exit.
      *
-     * @param child - The child process to kill
-     * @param options - Kill options including signal and timeout
-     * @returns The spawn result after the process exits
+     * @param child - the child process to kill
+     * @param options - kill options including signal and timeout
+     * @returns the spawn result after the process exits
      */
     despawn(child: ChildProcess, options?: DespawnOptions): Promise<SpawnResult>;
     /**
      * Kills all processes in this registry.
      *
-     * @param options - Kill options applied to all processes
-     * @returns Array of spawn results
+     * @param options - kill options applied to all processes
+     * @returns array of spawn results
      */
     despawn_all(options?: DespawnOptions): Promise<Array<SpawnResult>>;
     /**
@@ -184,14 +184,14 @@ export declare class ProcessRegistry {
      * graceful shutdown uses a blocking busy-wait. This may not be sufficient
      * for processes that need significant cleanup time.
      *
-     * @param options - Configuration options
+     * @param options - configuration options
      * @param options.to_error_label - Customize error label, return `null` for default
      * @param options.map_error_text - Customize error text, return `''` to silence
      * @param options.handle_error - Called after cleanup, defaults to `process.exit(1)`
      * @param options.graceful_timeout_ms - If set, sends SIGTERM first and waits this
      *   many ms before SIGKILL. Recommended: 100-500ms. If null/undefined, uses
      *   immediate SIGKILL (default).
-     * @returns Cleanup function to remove the handler
+     * @returns cleanup function to remove the handler
      */
     attach_error_handler(options?: {
         to_error_label?: (err: Error, origin: NodeJS.UncaughtExceptionOrigin) => string | null;
@@ -256,19 +256,19 @@ export declare const despawn_all: (options?: DespawnOptions) => Promise<Array<Sp
 /**
  * Attaches an `uncaughtException` handler to the default registry.
  *
- * @see ProcessRegistry.attach_error_handler
+ * @see `ProcessRegistry.attach_error_handler`
  */
 export declare const attach_process_error_handler: (options?: Parameters<ProcessRegistry["attach_error_handler"]>[0]) => (() => void);
 /**
  * Spawns a detached process that continues after parent exits.
  *
- * Unlike other spawn functions, this is NOT tracked in any ProcessRegistry.
+ * Unlike other spawn functions, this is NOT tracked in any `ProcessRegistry`.
  * The spawned process is meant to outlive the parent (e.g., daemon processes).
  *
- * @param command - The command to run
- * @param args - Arguments to pass to the command
- * @param options - Spawn options (use `stdio` to redirect output to file descriptors)
- * @returns Result with pid on success, or error message on failure
+ * @param command - the command to run
+ * @param args - arguments to pass to the command
+ * @param options - spawn options (use `stdio` to redirect output to file descriptors)
+ * @returns result with pid on success, or error message on failure
  *
  * @example
  * ```ts
@@ -381,7 +381,7 @@ export declare const spawn_restartable_process: (command: string, args?: Readonl
  * Checks if a process with the given PID is running.
  * Uses signal 0 which checks existence without sending a signal.
  *
- * @param pid - The process ID to check (must be a positive integer)
+ * @param pid - the process ID to check (must be a positive integer)
  * @returns `true` if the process exists (even without permission to signal it),
  *   `false` if the process doesn't exist or if pid is invalid (non-positive, non-integer, NaN, Infinity)
  */

package/dist/process.js

@@ -111,10 +111,10 @@ export class ProcessRegistry {
      * Spawns a process and tracks it in this registry.
      * The process is automatically unregistered when it exits.
      *
-     * @param command - The command to run
-     * @param args - Arguments to pass to the command
-     * @param options - Spawn options including `signal` and `timeout_ms`
-     * @returns Handle with `child` process and `closed` promise
+     * @param command - the command to run
+     * @param args - arguments to pass to the command
+     * @param options - spawn options including `signal` and `timeout_ms`
+     * @returns handle with `child` process and `closed` promise
      */
     spawn(command, args = [], options) {
         const { signal, timeout_ms, spawn_child_process = node_spawn_child_process, ...spawn_options } = options ?? {};
@@ -141,10 +141,10 @@ export class ProcessRegistry {
      * Spawns a process and captures stdout/stderr as strings.
      * Sets `stdio: 'pipe'` automatically.
      *
-     * @param command - The command to run
-     * @param args - Arguments to pass to the command
-     * @param options - Spawn options
-     * @returns Result with captured `stdout` and `stderr`.
+     * @param command - the command to run
+     * @param args - arguments to pass to the command
+     * @param options - spawn options
+     * @returns result with captured `stdout` and `stderr`
      *   - `null` means spawn failed (ENOENT, etc.) or stream was unavailable
      *   - `''` (empty string) means process ran but produced no output
      *   - non-empty string contains the captured output
@@ -178,9 +178,9 @@ export class ProcessRegistry {
     /**
      * Kills a child process and waits for it to exit.
      *
-     * @param child - The child process to kill
-     * @param options - Kill options including signal and timeout
-     * @returns The spawn result after the process exits
+     * @param child - the child process to kill
+     * @param options - kill options including signal and timeout
+     * @returns the spawn result after the process exits
      */
     async despawn(child, options) {
         const { signal = 'SIGTERM', timeout_ms } = options ?? {};
@@ -218,8 +218,8 @@ export class ProcessRegistry {
     /**
      * Kills all processes in this registry.
      *
-     * @param options - Kill options applied to all processes
-     * @returns Array of spawn results
+     * @param options - kill options applied to all processes
+     * @returns array of spawn results
      */
     async despawn_all(options) {
         return Promise.all([...this.processes].map((child) => this.despawn(child, options)));
@@ -236,14 +236,14 @@ export class ProcessRegistry {
      * graceful shutdown uses a blocking busy-wait. This may not be sufficient
      * for processes that need significant cleanup time.
      *
-     * @param options - Configuration options
+     * @param options - configuration options
      * @param options.to_error_label - Customize error label, return `null` for default
      * @param options.map_error_text - Customize error text, return `''` to silence
      * @param options.handle_error - Called after cleanup, defaults to `process.exit(1)`
      * @param options.graceful_timeout_ms - If set, sends SIGTERM first and waits this
      *   many ms before SIGKILL. Recommended: 100-500ms. If null/undefined, uses
      *   immediate SIGKILL (default).
-     * @returns Cleanup function to remove the handler
+     * @returns cleanup function to remove the handler
      */
     attach_error_handler(options) {
         if (this.#error_handler) {
@@ -348,19 +348,19 @@ export const despawn_all = (options) => process_registry_default.despawn_all(opt
 /**
  * Attaches an `uncaughtException` handler to the default registry.
  *
- * @see ProcessRegistry.attach_error_handler
+ * @see `ProcessRegistry.attach_error_handler`
  */
 export const attach_process_error_handler = (options) => process_registry_default.attach_error_handler(options);
 /**
  * Spawns a detached process that continues after parent exits.
  *
- * Unlike other spawn functions, this is NOT tracked in any ProcessRegistry.
+ * Unlike other spawn functions, this is NOT tracked in any `ProcessRegistry`.
  * The spawned process is meant to outlive the parent (e.g., daemon processes).
  *
- * @param command - The command to run
- * @param args - Arguments to pass to the command
- * @param options - Spawn options (use `stdio` to redirect output to file descriptors)
- * @returns Result with pid on success, or error message on failure
+ * @param command - the command to run
+ * @param args - arguments to pass to the command
+ * @param options - spawn options (use `stdio` to redirect output to file descriptors)
+ * @returns result with pid on success, or error message on failure
  *
  * @example
  * ```ts
@@ -556,7 +556,7 @@ export const spawn_restartable_process = (command, args = [], options) => {
  * Checks if a process with the given PID is running.
  * Uses signal 0 which checks existence without sending a signal.
  *
- * @param pid - The process ID to check (must be a positive integer)
+ * @param pid - the process ID to check (must be a positive integer)
  * @returns `true` if the process exists (even without permission to signal it),
  *   `false` if the process doesn't exist or if pid is invalid (non-positive, non-integer, NaN, Infinity)
  */

package/dist/random.d.ts

@@ -2,8 +2,8 @@
  * Random helpers that accept an optional `random` parameter,
  * defaulting to `Math.random`. Pass a seeded PRNG for reproducible results:
  *
- * - {@link create_random_xoshiro} — fast, high-quality numeric seeding (recommended)
- * - {@link create_random_alea} — supports string and variadic seeds
+ * - `create_random_xoshiro` — fast, high-quality numeric seeding (recommended)
+ * - `create_random_alea` — supports string and variadic seeds
  *
  * @module
  */

package/dist/random.js

@@ -2,8 +2,8 @@
  * Random helpers that accept an optional `random` parameter,
  * defaulting to `Math.random`. Pass a seeded PRNG for reproducible results:
  *
- * - {@link create_random_xoshiro} — fast, high-quality numeric seeding (recommended)
- * - {@link create_random_alea} — supports string and variadic seeds
+ * - `create_random_xoshiro` — fast, high-quality numeric seeding (recommended)
+ * - `create_random_alea` — supports string and variadic seeds
  *
  * @module
  */

package/dist/result.d.ts

@@ -24,9 +24,9 @@ export declare const NOT_OK: Readonly<{
  * A helper that says,
  * "hey I know this is wrapped in a `Result`, but I expect it to be `ok`,
  * so if it's not, I understand it will throw an error that wraps the result".
- * @param result Some `Result` object.
- * @param message Optional custom error message.
- * @returns The wrapped value.
+ * @param result - some `Result` object
+ * @param message - optional custom error message
+ * @returns the wrapped value
  */
 export declare const unwrap: <TValue extends {
     value?: unknown;
@@ -54,9 +54,9 @@ export declare class ResultError extends Error {
 /**
  * A helper that does the opposite of `unwrap`, throwing if the `Result` is ok.
  * Note that while `unwrap` returns the wrapped `value`, `unwrap_error` returns the entire result.
- * @param result Some `Result` object.
- * @param message Optional custom error message.
- * @returns The type-narrowed result.
+ * @param result - some `Result` object
+ * @param message - optional custom error message
+ * @returns the type-narrowed result
  */
 export declare const unwrap_error: <TError extends object>(result: Result<object, TError>, message?: string) => {
     ok: false;

package/dist/result.js

@@ -10,9 +10,9 @@ export const NOT_OK = Object.freeze({ ok: false });
  * A helper that says,
  * "hey I know this is wrapped in a `Result`, but I expect it to be `ok`,
  * so if it's not, I understand it will throw an error that wraps the result".
- * @param result Some `Result` object.
- * @param message Optional custom error message.
- * @returns The wrapped value.
+ * @param result - some `Result` object
+ * @param message - optional custom error message
+ * @returns the wrapped value
  */
 export const unwrap = (result, message) => {
     if (!result.ok)
@@ -37,9 +37,9 @@ export class ResultError extends Error {
 /**
  * A helper that does the opposite of `unwrap`, throwing if the `Result` is ok.
  * Note that while `unwrap` returns the wrapped `value`, `unwrap_error` returns the entire result.
- * @param result Some `Result` object.
- * @param message Optional custom error message.
- * @returns The type-narrowed result.
+ * @param result - some `Result` object
+ * @param message - optional custom error message
+ * @returns the type-narrowed result
  */
 export const unwrap_error = (result, message = 'Failed to unwrap result error') => {
     if (result.ok)

package/dist/sort.d.ts

@@ -30,9 +30,9 @@ export type TopologicalSortResult<T extends Sortable> = {
  * Returns items ordered so that dependencies come before dependents.
  * If a cycle is detected, returns an error with the cycle path.
  *
- * @param items - Array of items to sort.
- * @param label - Label for error messages (e.g. "resource", "step").
- * @returns Sorted items or error if cycle detected.
+ * @param items - array of items to sort
+ * @param label - label for error messages (e.g. "resource", "step")
+ * @returns sorted items or error if cycle detected
  */
 export declare const topological_sort: <T extends Sortable>(items: Array<T>, label?: string) => TopologicalSortResult<T>;
 //# sourceMappingURL=sort.d.ts.map

package/dist/sort.js

@@ -12,9 +12,9 @@
  * Returns items ordered so that dependencies come before dependents.
  * If a cycle is detected, returns an error with the cycle path.
  *
- * @param items - Array of items to sort.
- * @param label - Label for error messages (e.g. "resource", "step").
- * @returns Sorted items or error if cycle detected.
+ * @param items - array of items to sort
+ * @param label - label for error messages (e.g. "resource", "step")
+ * @returns sorted items or error if cycle detected
  */
 export const topological_sort = (items, label = 'item') => {
     // Build id -> item map

package/dist/source_json.d.ts

@@ -5,7 +5,7 @@
  * extracted at build time via TypeScript compiler analysis.
  * Used for generating API documentation and enabling code search.
  *
- * Hierarchy: SourceJson → ModuleJson → DeclarationJson
+ * Hierarchy: `SourceJson` → `ModuleJson` → `DeclarationJson`
  *
  * @module
  */
@@ -39,7 +39,7 @@ export type GenericParamInfo = z.infer<typeof GenericParamInfo>;
 /**
  * Parameter information for functions and methods.
  *
- * Kept distinct from ComponentPropInfo despite structural similarity.
+ * Kept distinct from `ComponentPropInfo` despite structural similarity.
  * Function parameters form a tuple with positional semantics:
  * calling order matters (`fn(a, b)` vs `fn(b, a)`),
  * may include rest parameters and destructuring patterns.
@@ -55,7 +55,7 @@ export type ParameterInfo = z.infer<typeof ParameterInfo>;
 /**
  * Component prop information for Svelte components.
  *
- * Kept distinct from ParameterInfo despite structural similarity.
+ * Kept distinct from `ParameterInfo` despite structural similarity.
  * Component props are named attributes with different semantics:
  * no positional order when passing (`<Foo {a} {b} />` = `<Foo {b} {a} />`),
  * support two-way binding via `$bindable` rune.

package/dist/source_json.js

@@ -5,7 +5,7 @@
  * extracted at build time via TypeScript compiler analysis.
  * Used for generating API documentation and enabling code search.
  *
- * Hierarchy: SourceJson → ModuleJson → DeclarationJson
+ * Hierarchy: `SourceJson` → `ModuleJson` → `DeclarationJson`
  *
  * @module
  */
@@ -37,7 +37,7 @@ export const GenericParamInfo = z.looseObject({
 /**
  * Parameter information for functions and methods.
  *
- * Kept distinct from ComponentPropInfo despite structural similarity.
+ * Kept distinct from `ComponentPropInfo` despite structural similarity.
  * Function parameters form a tuple with positional semantics:
  * calling order matters (`fn(a, b)` vs `fn(b, a)`),
  * may include rest parameters and destructuring patterns.
@@ -52,7 +52,7 @@ export const ParameterInfo = z.looseObject({
 /**
  * Component prop information for Svelte components.
  *
- * Kept distinct from ParameterInfo despite structural similarity.
+ * Kept distinct from `ParameterInfo` despite structural similarity.
  * Component props are named attributes with different semantics:
  * no positional order when passing (`<Foo {a} {b} />` = `<Foo {b} {a} />`),
  * support two-way binding via `$bindable` rune.

package/dist/stats.d.ts

@@ -26,8 +26,8 @@ export declare const stats_variance: (values: Array<number>, mean?: number) => n
  * Calculate a percentile of an array of numbers using linear interpolation.
  * Uses the "R-7" method (default in R, NumPy, Excel) which interpolates between
  * data points for more accurate percentile estimates, especially with smaller samples.
- * @param values - Array of numbers
- * @param p - Percentile (0-1, e.g., 0.95 for 95th percentile)
+ * @param values - array of numbers
+ * @param p - percentile (0-1, e.g., 0.95 for 95th percentile)
  */
 export declare const stats_percentile: (values: Array<number>, p: number) => number;
 /**
@@ -120,18 +120,18 @@ export interface StatsConfidenceIntervalOptions {
 }
 /**
  * Calculate confidence interval for the mean.
- * @param values - Array of numbers
- * @param options - Configuration options
+ * @param values - array of numbers
+ * @param options - configuration options
  * @returns [lower_bound, upper_bound]
  */
 export declare const stats_confidence_interval: (values: Array<number>, options?: StatsConfidenceIntervalOptions) => [number, number];
 /**
  * Calculate confidence interval from summary statistics (mean, std_dev, sample_size).
  * Useful when raw data is not available.
- * @param mean - Mean of the data
- * @param std_dev - Standard deviation of the data
- * @param sample_size - Number of samples
- * @param options - Configuration options
+ * @param mean - mean of the data
+ * @param std_dev - standard deviation of the data
+ * @param sample_size - number of samples
+ * @param options - configuration options
  * @returns [lower_bound, upper_bound]
  */
 export declare const stats_confidence_interval_from_summary: (mean: number, std_dev: number, sample_size: number, options?: StatsConfidenceIntervalOptions) => [number, number];
@@ -148,12 +148,12 @@ export interface StatsWelchTTestResult {
  * Calculate Welch's t-test statistic and degrees of freedom.
  * Welch's t-test is more robust than Student's t-test when variances are unequal.
  *
- * @param mean1 - Mean of first sample
- * @param std1 - Standard deviation of first sample
- * @param n1 - Size of first sample
- * @param mean2 - Mean of second sample
- * @param std2 - Standard deviation of second sample
- * @param n2 - Size of second sample
+ * @param mean1 - mean of first sample
+ * @param std1 - standard deviation of first sample
+ * @param n1 - size of first sample
+ * @param mean2 - mean of second sample
+ * @param std2 - standard deviation of second sample
+ * @param n2 - size of second sample
  */
 export declare const stats_welch_t_test: (mean1: number, std1: number, n1: number, mean2: number, std2: number, n2: number) => StatsWelchTTestResult;
 /**
@@ -174,9 +174,9 @@ export declare const stats_incomplete_beta: (x: number, a: number, b: number) =>
  * For large df (>100), uses normal approximation.
  * For smaller df, uses incomplete beta function.
  *
- * @param t - Absolute value of t-statistic
- * @param df - Degrees of freedom
- * @returns Two-tailed p-value
+ * @param t - absolute value of t-statistic
+ * @param df - degrees of freedom
+ * @returns two-tailed p-value
  */
 export declare const stats_t_distribution_p_value: (t: number, df: number) => number;
 //# sourceMappingURL=stats.d.ts.map

package/dist/stats.js

@@ -57,8 +57,8 @@ export const stats_variance = (values, mean) => {
  * Calculate a percentile of an array of numbers using linear interpolation.
  * Uses the "R-7" method (default in R, NumPy, Excel) which interpolates between
  * data points for more accurate percentile estimates, especially with smaller samples.
- * @param values - Array of numbers
- * @param p - Percentile (0-1, e.g., 0.95 for 95th percentile)
+ * @param values - array of numbers
+ * @param p - percentile (0-1, e.g., 0.95 for 95th percentile)
  */
 export const stats_percentile = (values, p) => {
     if (values.length === 0)
@@ -245,8 +245,8 @@ export const stats_confidence_level_to_z_score = (level) => {
 };
 /**
  * Calculate confidence interval for the mean.
- * @param values - Array of numbers
- * @param options - Configuration options
+ * @param values - array of numbers
+ * @param options - configuration options
  * @returns [lower_bound, upper_bound]
  */
 export const stats_confidence_interval = (values, options) => {
@@ -259,10 +259,10 @@ export const stats_confidence_interval = (values, options) => {
 /**
  * Calculate confidence interval from summary statistics (mean, std_dev, sample_size).
  * Useful when raw data is not available.
- * @param mean - Mean of the data
- * @param std_dev - Standard deviation of the data
- * @param sample_size - Number of samples
- * @param options - Configuration options
+ * @param mean - mean of the data
+ * @param std_dev - standard deviation of the data
+ * @param sample_size - number of samples
+ * @param options - configuration options
  * @returns [lower_bound, upper_bound]
  */
 export const stats_confidence_interval_from_summary = (mean, std_dev, sample_size, options) => {
@@ -282,12 +282,12 @@ export const stats_confidence_interval_from_summary = (mean, std_dev, sample_siz
  * Calculate Welch's t-test statistic and degrees of freedom.
  * Welch's t-test is more robust than Student's t-test when variances are unequal.
  *
- * @param mean1 - Mean of first sample
- * @param std1 - Standard deviation of first sample
- * @param n1 - Size of first sample
- * @param mean2 - Mean of second sample
- * @param std2 - Standard deviation of second sample
- * @param n2 - Size of second sample
+ * @param mean1 - mean of first sample
+ * @param std1 - standard deviation of first sample
+ * @param n1 - size of first sample
+ * @param mean2 - mean of second sample
+ * @param std2 - standard deviation of second sample
+ * @param n2 - size of second sample
  */
 export const stats_welch_t_test = (mean1, std1, n1, mean2, std2, n2) => {
     const var1 = std1 ** 2;
@@ -386,9 +386,9 @@ export const stats_incomplete_beta = (x, a, b) => {
  * For large df (>100), uses normal approximation.
  * For smaller df, uses incomplete beta function.
  *
- * @param t - Absolute value of t-statistic
- * @param df - Degrees of freedom
- * @returns Two-tailed p-value
+ * @param t - absolute value of t-statistic
+ * @param df - degrees of freedom
+ * @returns two-tailed p-value
  */
 export const stats_t_distribution_p_value = (t, df) => {
     // Use normal approximation for large df

package/dist/string.d.ts

@@ -39,7 +39,7 @@ export declare const plural: (count: number | undefined | null, suffix?: string)
  */
 export declare const count_graphemes: (str: string) => number;
 /**
- * Strips ANSI escape sequences from a string
+ * Strips ANSI escape sequences from a string.
  */
 export declare const strip_ansi: (str: string) => string;
 /**
@@ -65,9 +65,9 @@ export declare const pad_width: (str: string, target_width: number, align?: "lef
  * Calculates the Levenshtein distance between two strings.
  * Useful for typo detection and fuzzy matching.
  *
- * @param a - First string
- * @param b - Second string
- * @returns The edit distance between the strings
+ * @param a - first string
+ * @param b - second string
+ * @returns the edit distance between the strings
  */
 export declare const levenshtein_distance: (a: string, b: string) => number;
 /**
@@ -82,8 +82,8 @@ export declare const escape_js_string: (value: string) => string;
  *
  * Checks for null bytes in the first 8KB of content.
  *
- * @param content - Content to check.
- * @returns True if content appears to be binary.
+ * @param content - content to check
+ * @returns true if content appears to be binary
  */
 export declare const string_is_binary: (content: string) => boolean;
 //# sourceMappingURL=string.d.ts.map

package/dist/string.js

@@ -81,7 +81,7 @@ export const plural = (count, suffix = 's') => count === 1 ? '' : suffix;
  */
 export const count_graphemes = (str) => count_iterator(new Intl.Segmenter().segment(str));
 /**
- * Strips ANSI escape sequences from a string
+ * Strips ANSI escape sequences from a string.
  */
 export const strip_ansi = (str) => str.replaceAll(/\x1B\[[0-9;]*[a-zA-Z]/g, ''); // eslint-disable-line no-control-regex
 /**
@@ -152,9 +152,9 @@ export const pad_width = (str, target_width, align = 'left') => {
  * Calculates the Levenshtein distance between two strings.
  * Useful for typo detection and fuzzy matching.
  *
- * @param a - First string
- * @param b - Second string
- * @returns The edit distance between the strings
+ * @param a - first string
+ * @param b - second string
+ * @returns the edit distance between the strings
  */
 export const levenshtein_distance = (a, b) => {
     if (a.length === 0)
@@ -220,7 +220,7 @@ export const escape_js_string = (value) => value.replace(/[\\'\n\r\u2028\u2029]/
  *
  * Checks for null bytes in the first 8KB of content.
  *
- * @param content - Content to check.
- * @returns True if content appears to be binary.
+ * @param content - content to check
+ * @returns true if content appears to be binary
  */
 export const string_is_binary = (content) => content.slice(0, 8192).includes('\0');