@fuzdev/fuz_util 0.54.0 → 0.56.0

package/dist/svelte_preprocess_helpers.d.ts

@@ -33,9 +33,9 @@ export interface ResolvedComponentImport {
  * Iterates the node's `attributes` array and returns the first `Attribute`
  * node whose `name` matches. Skips `SpreadAttribute`, directive, and other node types.
  *
- * @param node The component AST node to search.
- * @param name The attribute name to find.
- * @returns The matching `Attribute` node, or `undefined` if not found.
+ * @param node - the component AST node to search
+ * @param name - the attribute name to find
+ * @returns the matching `Attribute` node, or `undefined` if not found
  */
 export declare const find_attribute: (node: AST.Component, name: string) => AST.Attribute | undefined;
 /**
@@ -46,9 +46,9 @@ export declare const find_attribute: (node: AST.Component, name: string) => AST.
  * via an optional bindings map built by `build_static_bindings`.
  * Returns `null` for dynamic expressions, non-string literals, or unsupported node types.
  *
- * @param expr An ESTree expression AST node.
- * @param bindings Optional map of variable names to their resolved static string values.
- * @returns The resolved static string, or `null` if the expression is dynamic.
+ * @param expr - an ESTree expression AST node
+ * @param bindings - optional map of variable names to their resolved static string values
+ * @returns the resolved static string, or `null` if the expression is dynamic
  */
 export declare const evaluate_static_expr: (expr: Expression, bindings?: ReadonlyMap<string, string>) => string | null;
 /**
@@ -62,9 +62,9 @@ export declare const evaluate_static_expr: (expr: Expression, bindings?: Readonl
  *
  * Returns `null` for null literals, mixed arrays, dynamic expressions, and non-string values.
  *
- * @param value The attribute value from `AST.Attribute['value']`.
- * @param bindings Optional map of variable names to their resolved static string values.
- * @returns The resolved static string, or `null` if the value is dynamic.
+ * @param value - the attribute value from `AST.Attribute['value']`
+ * @param bindings - optional map of variable names to their resolved static string values
+ * @returns the resolved static string, or `null` if the value is dynamic
  */
 export declare const extract_static_string: (value: AST.Attribute["value"], bindings?: ReadonlyMap<string, string>) => string | null;
 /** A single branch in a conditional chain extracted from nested ternary expressions. */
@@ -88,10 +88,10 @@ export interface ConditionalChainBranch {
  *
  * A 2-branch result covers the simple ternary case (`a ? 'x' : 'y'`).
  *
- * @param value The attribute value from `AST.Attribute['value']`.
- * @param source The full source string (needed to slice test expression source text).
- * @param bindings Map of variable names to their resolved static string values.
- * @returns Array of conditional chain branches, or `null` if not extractable.
+ * @param value - the attribute value from `AST.Attribute['value']`
+ * @param source - the full source string (needed to slice test expression source text)
+ * @param bindings - map of variable names to their resolved static string values
+ * @returns array of conditional chain branches, or `null` if not extractable
  */
 export declare const try_extract_conditional_chain: (value: AST.Attribute["value"], source: string, bindings: ReadonlyMap<string, string>) => Array<ConditionalChainBranch> | null;
 /**
@@ -105,8 +105,8 @@ export declare const try_extract_conditional_chain: (value: AST.Attribute["value
  * Skips destructuring patterns, `let`/`var` declarations, and declarations
  * whose initializers reference dynamic values.
  *
- * @param ast The parsed Svelte AST root node.
- * @returns Map of variable names to their resolved static string values.
+ * @param ast - the parsed Svelte AST root node
+ * @returns map of variable names to their resolved static string values
  */
 export declare const build_static_bindings: (ast: AST.Root) => Map<string, string>;
 /**
@@ -117,9 +117,9 @@ export declare const build_static_bindings: (ast: AST.Root) => Map<string, strin
  * and `import type` declarations (both whole-declaration and per-specifier).
  * Returns import node references alongside names to support import removal.
  *
- * @param ast The parsed Svelte AST root node.
- * @param component_imports Array of import source paths to match against.
- * @returns Map of local names to their resolved import info.
+ * @param ast - the parsed Svelte AST root node
+ * @param component_imports - array of import source paths to match against
+ * @returns map of local names to their resolved import info
  */
 export declare const resolve_component_names: (ast: AST.Root, component_imports: Array<string>) => Map<string, ResolvedComponentImport>;
 /**
@@ -128,8 +128,8 @@ export declare const resolve_component_names: (ast: AST.Root, component_imports:
  * Returns the end position of the last `ImportDeclaration`, or the start
  * of the script body content if no imports exist.
  *
- * @param script The parsed `AST.Script` node.
- * @returns The character position where new imports should be inserted.
+ * @param script - the parsed `AST.Script` node
+ * @returns the character position where new imports should be inserted
  */
 export declare const find_import_insert_position: (script: AST.Script) => number;
 /**
@@ -138,9 +138,9 @@ export declare const find_import_insert_position: (script: AST.Script) => number
  * Default imports produce `import Name from 'path';` lines.
  * Named imports are grouped by path into `import {a, b} from 'path';` lines.
  *
- * @param imports Map of local names to their import info.
- * @param indent Indentation prefix for each line. @default '\t'
- * @returns A string of newline-separated import statements.
+ * @param imports - map of local names to their import info
+ * @param indent - indentation prefix for each line @default '\t'
+ * @returns a string of newline-separated import statements
  */
 export declare const generate_import_lines: (imports: Map<string, PreprocessImportInfo>, indent?: string) => string;
 /**
@@ -158,10 +158,10 @@ export declare const generate_import_lines: (imports: Map<string, PreprocessImpo
  * Safe for Svelte template ASTs: `Component.name` is a plain string property
  * (not an `Identifier` node), so `<Mdz>` tags do not produce false matches.
  *
- * @param node The AST subtree to search.
- * @param name The identifier name to look for.
- * @param skip Set of AST nodes to skip during traversal.
- * @returns `true` if a matching `Identifier` node is found.
+ * @param node - the AST subtree to search
+ * @param name - the identifier name to look for
+ * @param skip - set of AST nodes to skip during traversal
+ * @returns `true` if a matching `Identifier` node is found
  */
 export declare const has_identifier_in_tree: (node: unknown, name: string, skip?: Set<unknown>) => boolean;
 /**
@@ -188,9 +188,9 @@ export declare const escape_svelte_text: (text: string) => string;
  * blank lines. Only safe for single-declarator statements (`const x = 'val';`);
  * callers must verify `node.declarations.length === 1` before calling.
  *
- * @param s The MagicString instance to modify.
- * @param declaration_node The `VariableDeclaration` AST node with Svelte position data.
- * @param source The original source string.
+ * @param s - the MagicString instance to modify
+ * @param declaration_node - the `VariableDeclaration` AST node with Svelte position data
+ * @param source - the original source string
  */
 export declare const remove_variable_declaration: (s: {
     remove: (start: number, end: number) => unknown;
@@ -204,9 +204,9 @@ export declare const remove_variable_declaration: (s: {
  * Consumes leading whitespace (tabs/spaces) and trailing newline to avoid leaving
  * blank lines.
  *
- * @param s The MagicString instance to modify.
- * @param import_node The `ImportDeclaration` AST node with Svelte position data.
- * @param source The original source string.
+ * @param s - the MagicString instance to modify
+ * @param import_node - the `ImportDeclaration` AST node with Svelte position data
+ * @param source - the original source string
  */
 export declare const remove_import_declaration: (s: {
     remove: (start: number, end: number) => unknown;
@@ -225,11 +225,11 @@ export declare const remove_import_declaration: (s: {
  * - `import {default as Mdz, other} from '...'` → `import {other} from '...'`
  * - `import {Mdz, other} from '...'` → `import {other} from '...'`
  *
- * @param s The MagicString instance to modify.
- * @param node The positioned `ImportDeclaration` AST node.
- * @param specifier_to_remove The specifier to remove from the import.
- * @param source The original source string.
- * @param additional_lines Extra content appended after the reconstructed import
+ * @param s - the MagicString instance to modify
+ * @param node - the positioned `ImportDeclaration` AST node
+ * @param specifier_to_remove - the specifier to remove from the import
+ * @param source - the original source string
+ * @param additional_lines - extra content appended after the reconstructed import
  *   (used to bundle new imports into the overwrite to avoid MagicString boundary conflicts).
  */
 export declare const remove_import_specifier: (s: {
@@ -241,10 +241,10 @@ export declare const remove_import_specifier: (s: {
 /**
  * Handles errors during Svelte preprocessing with configurable behavior.
  *
- * @param error The caught error.
- * @param prefix Log prefix (e.g. `'[fuz-mdz]'`, `'[fuz-code]'`).
- * @param filename The file being processed.
- * @param on_error `'throw'` to re-throw as a new Error, `'log'` to console.error.
+ * @param error - the caught error
+ * @param prefix - log prefix (e.g. `'[fuz-mdz]'`, `'[fuz-code]'`)
+ * @param filename - the file being processed
+ * @param on_error - `'throw'` to re-throw as a new Error, `'log'` to console.error
  */
 export declare const handle_preprocess_error: (error: unknown, prefix: string, filename: string | undefined, on_error: "throw" | "log") => void;
 //# sourceMappingURL=svelte_preprocess_helpers.d.ts.map

package/dist/svelte_preprocess_helpers.js

@@ -17,9 +17,9 @@
  * Iterates the node's `attributes` array and returns the first `Attribute`
  * node whose `name` matches. Skips `SpreadAttribute`, directive, and other node types.
  *
- * @param node The component AST node to search.
- * @param name The attribute name to find.
- * @returns The matching `Attribute` node, or `undefined` if not found.
+ * @param node - the component AST node to search
+ * @param name - the attribute name to find
+ * @returns the matching `Attribute` node, or `undefined` if not found
  */
 export const find_attribute = (node, name) => {
     for (const attr of node.attributes) {
@@ -37,9 +37,9 @@ export const find_attribute = (node, name) => {
  * via an optional bindings map built by `build_static_bindings`.
  * Returns `null` for dynamic expressions, non-string literals, or unsupported node types.
  *
- * @param expr An ESTree expression AST node.
- * @param bindings Optional map of variable names to their resolved static string values.
- * @returns The resolved static string, or `null` if the expression is dynamic.
+ * @param expr - an ESTree expression AST node
+ * @param bindings - optional map of variable names to their resolved static string values
+ * @returns the resolved static string, or `null` if the expression is dynamic
  */
 export const evaluate_static_expr = (expr, bindings) => {
     if (expr.type === 'Literal' && typeof expr.value === 'string')
@@ -89,9 +89,9 @@ export const evaluate_static_expr = (expr, bindings) => {
  *
  * Returns `null` for null literals, mixed arrays, dynamic expressions, and non-string values.
  *
- * @param value The attribute value from `AST.Attribute['value']`.
- * @param bindings Optional map of variable names to their resolved static string values.
- * @returns The resolved static string, or `null` if the value is dynamic.
+ * @param value - the attribute value from `AST.Attribute['value']`
+ * @param bindings - optional map of variable names to their resolved static string values
+ * @returns the resolved static string, or `null` if the value is dynamic
  */
 export const extract_static_string = (value, bindings) => {
     // Boolean attribute (e.g., <Mdz inline />)
@@ -126,10 +126,10 @@ export const extract_static_string = (value, bindings) => {
  *
  * A 2-branch result covers the simple ternary case (`a ? 'x' : 'y'`).
  *
- * @param value The attribute value from `AST.Attribute['value']`.
- * @param source The full source string (needed to slice test expression source text).
- * @param bindings Map of variable names to their resolved static string values.
- * @returns Array of conditional chain branches, or `null` if not extractable.
+ * @param value - the attribute value from `AST.Attribute['value']`
+ * @param source - the full source string (needed to slice test expression source text)
+ * @param bindings - map of variable names to their resolved static string values
+ * @returns array of conditional chain branches, or `null` if not extractable
  */
 export const try_extract_conditional_chain = (value, source, bindings) => {
     if (value === true || Array.isArray(value))
@@ -178,8 +178,8 @@ export const try_extract_conditional_chain = (value, source, bindings) => {
  * Skips destructuring patterns, `let`/`var` declarations, and declarations
  * whose initializers reference dynamic values.
  *
- * @param ast The parsed Svelte AST root node.
- * @returns Map of variable names to their resolved static string values.
+ * @param ast - the parsed Svelte AST root node
+ * @returns map of variable names to their resolved static string values
  */
 export const build_static_bindings = (ast) => {
     const bindings = new Map();
@@ -211,9 +211,9 @@ export const build_static_bindings = (ast) => {
  * and `import type` declarations (both whole-declaration and per-specifier).
  * Returns import node references alongside names to support import removal.
  *
- * @param ast The parsed Svelte AST root node.
- * @param component_imports Array of import source paths to match against.
- * @returns Map of local names to their resolved import info.
+ * @param ast - the parsed Svelte AST root node
+ * @param component_imports - array of import source paths to match against
+ * @returns map of local names to their resolved import info
  */
 export const resolve_component_names = (ast, component_imports) => {
     const names = new Map();
@@ -247,8 +247,8 @@ export const resolve_component_names = (ast, component_imports) => {
  * Returns the end position of the last `ImportDeclaration`, or the start
  * of the script body content if no imports exist.
  *
- * @param script The parsed `AST.Script` node.
- * @returns The character position where new imports should be inserted.
+ * @param script - the parsed `AST.Script` node
+ * @returns the character position where new imports should be inserted
  */
 export const find_import_insert_position = (script) => {
     let last_import_end = -1;
@@ -269,9 +269,9 @@ export const find_import_insert_position = (script) => {
  * Default imports produce `import Name from 'path';` lines.
  * Named imports are grouped by path into `import {a, b} from 'path';` lines.
  *
- * @param imports Map of local names to their import info.
- * @param indent Indentation prefix for each line. @default '\t'
- * @returns A string of newline-separated import statements.
+ * @param imports - map of local names to their import info
+ * @param indent - indentation prefix for each line @default '\t'
+ * @returns a string of newline-separated import statements
  */
 export const generate_import_lines = (imports, indent = '\t') => {
     const default_imports = [];
@@ -333,10 +333,10 @@ const NON_REFERENCE_FIELDS = new Map([
  * Safe for Svelte template ASTs: `Component.name` is a plain string property
  * (not an `Identifier` node), so `<Mdz>` tags do not produce false matches.
  *
- * @param node The AST subtree to search.
- * @param name The identifier name to look for.
- * @param skip Set of AST nodes to skip during traversal.
- * @returns `true` if a matching `Identifier` node is found.
+ * @param node - the AST subtree to search
+ * @param name - the identifier name to look for
+ * @param skip - set of AST nodes to skip during traversal
+ * @returns `true` if a matching `Identifier` node is found
  */
 export const has_identifier_in_tree = (node, name, skip) => {
     if (node === null || node === undefined || typeof node !== 'object')
@@ -396,9 +396,9 @@ export const escape_svelte_text = (text) => text.replace(/[{}<&]/g, (ch) => {
  * blank lines. Only safe for single-declarator statements (`const x = 'val';`);
  * callers must verify `node.declarations.length === 1` before calling.
  *
- * @param s The MagicString instance to modify.
- * @param declaration_node The `VariableDeclaration` AST node with Svelte position data.
- * @param source The original source string.
+ * @param s - the MagicString instance to modify
+ * @param declaration_node - the `VariableDeclaration` AST node with Svelte position data
+ * @param source - the original source string
  */
 export const remove_variable_declaration = (s, declaration_node, source) => {
     remove_positioned_node(s, declaration_node, source);
@@ -409,9 +409,9 @@ export const remove_variable_declaration = (s, declaration_node, source) => {
  * Consumes leading whitespace (tabs/spaces) and trailing newline to avoid leaving
  * blank lines.
  *
- * @param s The MagicString instance to modify.
- * @param import_node The `ImportDeclaration` AST node with Svelte position data.
- * @param source The original source string.
+ * @param s - the MagicString instance to modify
+ * @param import_node - the `ImportDeclaration` AST node with Svelte position data
+ * @param source - the original source string
  */
 export const remove_import_declaration = (s, import_node, source) => {
     remove_positioned_node(s, import_node, source);
@@ -450,11 +450,11 @@ const remove_positioned_node = (s, node, source) => {
  * - `import {default as Mdz, other} from '...'` → `import {other} from '...'`
  * - `import {Mdz, other} from '...'` → `import {other} from '...'`
  *
- * @param s The MagicString instance to modify.
- * @param node The positioned `ImportDeclaration` AST node.
- * @param specifier_to_remove The specifier to remove from the import.
- * @param source The original source string.
- * @param additional_lines Extra content appended after the reconstructed import
+ * @param s - the MagicString instance to modify
+ * @param node - the positioned `ImportDeclaration` AST node
+ * @param specifier_to_remove - the specifier to remove from the import
+ * @param source - the original source string
+ * @param additional_lines - extra content appended after the reconstructed import
  *   (used to bundle new imports into the overwrite to avoid MagicString boundary conflicts).
  */
 export const remove_import_specifier = (s, node, specifier_to_remove, source, additional_lines = '') => {
@@ -501,10 +501,10 @@ const format_named_specifiers = (specs) => specs
 /**
  * Handles errors during Svelte preprocessing with configurable behavior.
  *
- * @param error The caught error.
- * @param prefix Log prefix (e.g. `'[fuz-mdz]'`, `'[fuz-code]'`).
- * @param filename The file being processed.
- * @param on_error `'throw'` to re-throw as a new Error, `'log'` to console.error.
+ * @param error - the caught error
+ * @param prefix - log prefix (e.g. `'[fuz-mdz]'`, `'[fuz-code]'`)
+ * @param filename - the file being processed
+ * @param on_error - `'throw'` to re-throw as a new Error, `'log'` to console.error
  */
 export const handle_preprocess_error = (error, prefix, filename, on_error) => {
     const message = `${prefix} Preprocessing failed${filename ? ` in ${filename}` : ''}: ${error instanceof Error ? error.message : String(error)}`;

package/dist/testing.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Shared test assertions for the `@fuzdev` ecosystem.
+ *
+ * Extends the fuz-stack testing conventions (`assert` from vitest, tests in `src/test/`,
+ * plain object mocks) with reusable helpers for patterns that appear across multiple repos.
+ * Only depends on vitest — safe for fuz_util's zero-runtime-deps constraint.
+ *
+ * @module
+ */
+import type { Logger } from './log.js';
+/**
+ * Asserts that `fn` rejects with an `Error`.
+ * Optionally matches the error message against `pattern`.
+ * Returns the caught `Error` for further assertions by the caller.
+ *
+ * `assert.fail` is placed after the catch block so that assertion failures
+ * from the test itself are not swallowed by the catch.
+ *
+ * @param fn - async function expected to reject
+ * @param pattern - optional regex to match against the error message
+ * @returns the caught `Error`
+ */
+export declare const assert_rejects: (fn: () => Promise<unknown>, pattern?: RegExp) => Promise<Error>;
+/**
+ * A mock `Logger` with `vi.fn()` methods and call tracking arrays.
+ * Assignable to `Logger` for use in code under test.
+ * Each tracking array captures the first argument of each call.
+ * For full call details, use `vi.fn()` introspection on the methods directly.
+ */
+export type MockLogger = Logger & {
+    error_calls: Array<unknown>;
+    warn_calls: Array<unknown>;
+    info_calls: Array<unknown>;
+    debug_calls: Array<unknown>;
+};
+/**
+ * Creates a mock `Logger` with `vi.fn()` on each logging method
+ * and tracking arrays for inspecting logged messages.
+ * Follows the fuz-stack convention of plain object mocks over mocking libraries.
+ *
+ * @returns a `MockLogger` assignable to `Logger`
+ */
+export declare const create_mock_logger: () => MockLogger;
+//# sourceMappingURL=testing.d.ts.map

package/dist/testing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/testing.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAErC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GAC1B,IAAI,MAAM,OAAO,CAAC,OAAO,CAAC,EAC1B,UAAU,MAAM,KACd,OAAO,CAAC,KAAK,CAWf,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IACjC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAC5B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,QAAO,UAiBrC,CAAC"}

package/dist/testing.js

@@ -0,0 +1,59 @@
+/**
+ * Shared test assertions for the `@fuzdev` ecosystem.
+ *
+ * Extends the fuz-stack testing conventions (`assert` from vitest, tests in `src/test/`,
+ * plain object mocks) with reusable helpers for patterns that appear across multiple repos.
+ * Only depends on vitest — safe for fuz_util's zero-runtime-deps constraint.
+ *
+ * @module
+ */
+import { assert, vi } from 'vitest';
+/**
+ * Asserts that `fn` rejects with an `Error`.
+ * Optionally matches the error message against `pattern`.
+ * Returns the caught `Error` for further assertions by the caller.
+ *
+ * `assert.fail` is placed after the catch block so that assertion failures
+ * from the test itself are not swallowed by the catch.
+ *
+ * @param fn - async function expected to reject
+ * @param pattern - optional regex to match against the error message
+ * @returns the caught `Error`
+ */
+export const assert_rejects = async (fn, pattern) => {
+    try {
+        await fn();
+    }
+    catch (err) {
+        assert(err instanceof Error, 'Expected rejection to be an Error');
+        if (pattern) {
+            assert.match(err.message, pattern);
+        }
+        return err;
+    }
+    assert.fail('Expected to throw');
+};
+/**
+ * Creates a mock `Logger` with `vi.fn()` on each logging method
+ * and tracking arrays for inspecting logged messages.
+ * Follows the fuz-stack convention of plain object mocks over mocking libraries.
+ *
+ * @returns a `MockLogger` assignable to `Logger`
+ */
+export const create_mock_logger = () => {
+    const error_calls = [];
+    const warn_calls = [];
+    const info_calls = [];
+    const debug_calls = [];
+    return {
+        error: vi.fn((msg) => error_calls.push(msg)),
+        warn: vi.fn((msg) => warn_calls.push(msg)),
+        info: vi.fn((msg) => info_calls.push(msg)),
+        debug: vi.fn((msg) => debug_calls.push(msg)),
+        raw: vi.fn(),
+        error_calls,
+        warn_calls,
+        info_calls,
+        debug_calls,
+    };
+};

package/dist/time.d.ts

@@ -65,23 +65,23 @@ export declare const TIME_UNIT_DISPLAY: Record<TimeUnit, string>;
 /**
  * Detect the best time unit for a set of nanosecond values.
  * Chooses the unit where most values fall in the range 1-9999.
- * @param values_ns - Array of times in nanoseconds
- * @returns Best unit to use for all values
+ * @param values_ns - array of times in nanoseconds
+ * @returns best unit to use for all values
  */
 export declare const time_unit_detect_best: (values_ns: Array<number>) => TimeUnit;
 /**
  * Format time with a specific unit.
- * @param ns - Time in nanoseconds
- * @param unit - Unit to use ('ns', 'us', 'ms', 's')
- * @param decimals - Number of decimal places (default: 2)
- * @returns Formatted string like "3.87μs"
+ * @param ns - time in nanoseconds
+ * @param unit - unit to use ('ns', 'us', 'ms', 's')
+ * @param decimals - number of decimal places (default: 2)
+ * @returns formatted string like "3.87μs"
  */
 export declare const time_format: (ns: number, unit: TimeUnit, decimals?: number) => string;
 /**
  * Format time with adaptive units (ns/μs/ms/s) based on magnitude.
- * @param ns - Time in nanoseconds
- * @param decimals - Number of decimal places (default: 2)
- * @returns Formatted string like "3.87μs" or "1.23ms"
+ * @param ns - time in nanoseconds
+ * @param decimals - number of decimal places (default: 2)
+ * @returns formatted string like "3.87μs" or "1.23ms"
  *
  * @example
  * ```ts
@@ -110,9 +110,9 @@ export interface TimeResult {
 }
 /**
  * Time an asynchronous function execution.
- * @param fn - Async function to time
- * @param timer - Timer to use (defaults to timer_default)
- * @returns Object containing the function result and timing information
+ * @param fn - async function to time
+ * @param timer - timer to use (defaults to `timer_default`)
+ * @returns object containing the function result and timing information
  *
  * @example
  * ```ts
@@ -129,9 +129,9 @@ export declare const time_async: <T>(fn: () => Promise<T>, timer?: Timer) => Pro
 }>;
 /**
  * Time a synchronous function execution.
- * @param fn - Sync function to time
- * @param timer - Timer to use (defaults to timer_default)
- * @returns Object containing the function result and timing information
+ * @param fn - sync function to time
+ * @param timer - timer to use (defaults to `timer_default`)
+ * @returns object containing the function result and timing information
  *
  * @example
  * ```ts
@@ -147,10 +147,10 @@ export declare const time_sync: <T>(fn: () => T, timer?: Timer) => {
 };
 /**
  * Measure multiple executions of a function and return all timings.
- * @param fn - Function to measure (sync or async)
- * @param iterations - Number of times to execute
- * @param timer - Timer to use (defaults to timer_default)
- * @returns Array of elapsed times in nanoseconds
+ * @param fn - function to measure (sync or async)
+ * @param iterations - number of times to execute
+ * @param timer - timer to use (defaults to `timer_default`)
+ * @returns array of elapsed times in nanoseconds
  *
  * @example
  * ```ts

package/dist/time.js

@@ -96,8 +96,8 @@ export const TIME_UNIT_DISPLAY = { ns: 'ns', us: 'μs', ms: 'ms', s: 's' };
 /**
  * Detect the best time unit for a set of nanosecond values.
  * Chooses the unit where most values fall in the range 1-9999.
- * @param values_ns - Array of times in nanoseconds
- * @returns Best unit to use for all values
+ * @param values_ns - array of times in nanoseconds
+ * @returns best unit to use for all values
  */
 export const time_unit_detect_best = (values_ns) => {
     if (values_ns.length === 0)
@@ -125,10 +125,10 @@ export const time_unit_detect_best = (values_ns) => {
 };
 /**
  * Format time with a specific unit.
- * @param ns - Time in nanoseconds
- * @param unit - Unit to use ('ns', 'us', 'ms', 's')
- * @param decimals - Number of decimal places (default: 2)
- * @returns Formatted string like "3.87μs"
+ * @param ns - time in nanoseconds
+ * @param unit - unit to use ('ns', 'us', 'ms', 's')
+ * @param decimals - number of decimal places (default: 2)
+ * @returns formatted string like "3.87μs"
  */
 export const time_format = (ns, unit, decimals = 2) => {
     if (!isFinite(ns))
@@ -146,9 +146,9 @@ export const time_format = (ns, unit, decimals = 2) => {
 };
 /**
  * Format time with adaptive units (ns/μs/ms/s) based on magnitude.
- * @param ns - Time in nanoseconds
- * @param decimals - Number of decimal places (default: 2)
- * @returns Formatted string like "3.87μs" or "1.23ms"
+ * @param ns - time in nanoseconds
+ * @param decimals - number of decimal places (default: 2)
+ * @returns formatted string like "3.87μs" or "1.23ms"
  *
  * @example
  * ```ts
@@ -177,9 +177,9 @@ export const time_format_adaptive = (ns, decimals = 2) => {
 };
 /**
  * Time an asynchronous function execution.
- * @param fn - Async function to time
- * @param timer - Timer to use (defaults to timer_default)
- * @returns Object containing the function result and timing information
+ * @param fn - async function to time
+ * @param timer - timer to use (defaults to `timer_default`)
+ * @returns object containing the function result and timing information
  *
  * @example
  * ```ts
@@ -208,9 +208,9 @@ export const time_async = async (fn, timer = timer_default) => {
 };
 /**
  * Time a synchronous function execution.
- * @param fn - Sync function to time
- * @param timer - Timer to use (defaults to timer_default)
- * @returns Object containing the function result and timing information
+ * @param fn - sync function to time
+ * @param timer - timer to use (defaults to `timer_default`)
+ * @returns object containing the function result and timing information
  *
  * @example
  * ```ts
@@ -238,10 +238,10 @@ export const time_sync = (fn, timer = timer_default) => {
 };
 /**
  * Measure multiple executions of a function and return all timings.
- * @param fn - Function to measure (sync or async)
- * @param iterations - Number of times to execute
- * @param timer - Timer to use (defaults to timer_default)
- * @returns Array of elapsed times in nanoseconds
+ * @param fn - function to measure (sync or async)
+ * @param iterations - number of times to execute
+ * @param timer - timer to use (defaults to `timer_default`)
+ * @returns array of elapsed times in nanoseconds
  *
  * @example
  * ```ts