@fuzdev/fuz_util 0.55.0 → 0.56.0

package/dist/hex.d.ts

@@ -6,16 +6,16 @@
 /**
  * Converts a `Uint8Array` to a lowercase hex string.
  *
- * @param bytes - Binary data to encode.
- * @returns Hex string with two characters per byte.
+ * @param bytes - binary data to encode
+ * @returns hex string with two characters per byte
  */
 export declare const to_hex: (bytes: Uint8Array) => string;
 /**
  * Decodes a hex string to a `Uint8Array`.
  * Whitespace is stripped before parsing. Returns `null` for invalid hex.
  *
- * @param hex - Hex string to decode (case-insensitive, whitespace allowed).
- * @returns Decoded bytes, or `null` if the input is not valid hex.
+ * @param hex - hex string to decode (case-insensitive, whitespace allowed)
+ * @returns decoded bytes, or `null` if the input is not valid hex
  */
 export declare const from_hex: (hex: string) => Uint8Array | null;
 //# sourceMappingURL=hex.d.ts.map

package/dist/hex.js

@@ -6,8 +6,8 @@
 /**
  * Converts a `Uint8Array` to a lowercase hex string.
  *
- * @param bytes - Binary data to encode.
- * @returns Hex string with two characters per byte.
+ * @param bytes - binary data to encode
+ * @returns hex string with two characters per byte
  */
 export const to_hex = (bytes) => {
     const lookup = get_byte_to_hex();
@@ -21,8 +21,8 @@ export const to_hex = (bytes) => {
  * Decodes a hex string to a `Uint8Array`.
  * Whitespace is stripped before parsing. Returns `null` for invalid hex.
  *
- * @param hex - Hex string to decode (case-insensitive, whitespace allowed).
- * @returns Decoded bytes, or `null` if the input is not valid hex.
+ * @param hex - hex string to decode (case-insensitive, whitespace allowed)
+ * @returns decoded bytes, or `null` if the input is not valid hex
  */
 export const from_hex = (hex) => {
     const clean = hex.replace(/\s/g, '');

package/dist/json.d.ts

@@ -23,8 +23,8 @@ export declare const json_embed: <T>(data: T, stringify?: (data: T) => string) =
  * Recursively sorts object keys alphabetically for consistent hashing.
  * Arrays and primitives are serialized as-is.
  *
- * @param value Any JSON-serializable value
- * @returns Deterministic JSON string representation
+ * @param value - any JSON-serializable value
+ * @returns deterministic JSON string representation
  */
 export declare const json_stringify_deterministic: (value: unknown) => string;
 //# sourceMappingURL=json.d.ts.map

package/dist/json.js

@@ -28,8 +28,8 @@ export const json_embed = (data, stringify = JSON.stringify) => `JSON.parse('${s
  * Recursively sorts object keys alphabetically for consistent hashing.
  * Arrays and primitives are serialized as-is.
  *
- * @param value Any JSON-serializable value
- * @returns Deterministic JSON string representation
+ * @param value - any JSON-serializable value
+ * @returns deterministic JSON string representation
  */
 export const json_stringify_deterministic = (value) => JSON.stringify(value, (_key, val) => {
     if (val !== null && typeof val === 'object' && !Array.isArray(val)) {

package/dist/log.d.ts

@@ -8,21 +8,21 @@
  */
 export type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug';
 /**
- * Console interface subset used by Logger for output.
+ * Console interface subset used by `Logger` for output.
  * Allows custom console implementations for testing.
  */
 export type LogConsole = Pick<typeof console, 'error' | 'warn' | 'log'>;
 /**
  * Converts a log level to its numeric value for comparison.
  * Higher numbers indicate more verbose logging.
- * @param level The log level to convert
- * @returns Numeric value (0-4)
+ * @param level - the log level to convert
+ * @returns numeric value (0-4)
  */
 export declare const log_level_to_number: (level: LogLevel) => number;
 /**
  * Parses and validates a log level string.
- * @param value The value to parse as a log level
- * @returns The validated log level, or undefined if value is undefined
+ * @param value - the value to parse as a log level
+ * @returns the validated log level, or undefined if value is undefined
  * @throws Error if value is provided but invalid
  */
 export declare const log_level_parse: (value: string | undefined) => LogLevel | undefined;
@@ -56,10 +56,10 @@ export declare class Logger {
     /**
      * Creates a new Logger instance.
      *
-     * @param label Optional label for this logger. Can be `undefined` for no label, or an
+     * @param label - optional label for this logger. Can be `undefined` for no label, or an
      *   empty string `''` which is functionally equivalent (both produce no brackets in output).
      *   Note: Empty strings are only allowed for root loggers - child loggers cannot have empty labels.
-     * @param options Optional configuration for level, colors, and console
+     * @param options - optional configuration for level, colors, and console
      */
     constructor(label?: string, options?: LoggerOptions);
     /**
@@ -93,7 +93,7 @@ export declare class Logger {
     /**
      * Gets the root logger by walking up the parent chain.
      * Useful for setting global configuration that affects all child loggers.
-     * @returns The root logger (the one without a parent)
+     * @returns the root logger (the one without a parent)
      */
     get root(): Logger;
     /**
@@ -118,11 +118,11 @@ export declare class Logger {
      * Creates a child logger with automatic label concatenation.
      * Children inherit parent configuration unless overridden.
      *
-     * @param label Child label (will be concatenated with parent label using `:`).
+     * @param label - child label (will be concatenated with parent label using `:`)
      *   Cannot be an empty string - empty labels would result in confusing output like `parent:`
      *   with a trailing colon. Use `undefined` or `''` only for root loggers.
-     * @param options Optional configuration overrides
-     * @returns New Logger instance with concatenated label
+     * @param options - optional configuration overrides
+     * @returns new `Logger` instance with concatenated label
      * @throws Error if label is an empty string
      *
      * @example
@@ -163,7 +163,7 @@ export declare class Logger {
      * Note: This method ignores the configured log level - it always outputs regardless of
      * whether the logger is set to 'off' or any other level.
      *
-     * @param args Values to log directly to console
+     * @param args - values to log directly to console
      */
     raw(...args: Array<unknown>): void;
 }

package/dist/log.js

@@ -22,14 +22,14 @@ const LOG_LEVEL_VALUES = {
 /**
  * Converts a log level to its numeric value for comparison.
  * Higher numbers indicate more verbose logging.
- * @param level The log level to convert
- * @returns Numeric value (0-4)
+ * @param level - the log level to convert
+ * @returns numeric value (0-4)
  */
 export const log_level_to_number = (level) => LOG_LEVEL_VALUES[level];
 /**
  * Parses and validates a log level string.
- * @param value The value to parse as a log level
- * @returns The validated log level, or undefined if value is undefined
+ * @param value - the value to parse as a log level
+ * @returns the validated log level, or undefined if value is undefined
  * @throws Error if value is provided but invalid
  */
 export const log_level_parse = (value) => {
@@ -85,10 +85,10 @@ export class Logger {
     /**
      * Creates a new Logger instance.
      *
-     * @param label Optional label for this logger. Can be `undefined` for no label, or an
+     * @param label - optional label for this logger. Can be `undefined` for no label, or an
      *   empty string `''` which is functionally equivalent (both produce no brackets in output).
      *   Note: Empty strings are only allowed for root loggers - child loggers cannot have empty labels.
-     * @param options Optional configuration for level, colors, and console
+     * @param options - optional configuration for level, colors, and console
      */
     constructor(label, options = {}) {
         this.label = label;
@@ -169,7 +169,7 @@ export class Logger {
     /**
      * Gets the root logger by walking up the parent chain.
      * Useful for setting global configuration that affects all child loggers.
-     * @returns The root logger (the one without a parent)
+     * @returns the root logger (the one without a parent)
      */
     get root() {
         let current = this; // eslint-disable-line consistent-this, @typescript-eslint/no-this-alias
@@ -313,11 +313,11 @@ export class Logger {
      * Creates a child logger with automatic label concatenation.
      * Children inherit parent configuration unless overridden.
      *
-     * @param label Child label (will be concatenated with parent label using `:`).
+     * @param label - child label (will be concatenated with parent label using `:`)
      *   Cannot be an empty string - empty labels would result in confusing output like `parent:`
      *   with a trailing colon. Use `undefined` or `''` only for root loggers.
-     * @param options Optional configuration overrides
-     * @returns New Logger instance with concatenated label
+     * @param options - optional configuration overrides
+     * @returns new `Logger` instance with concatenated label
      * @throws Error if label is an empty string
      *
      * @example
@@ -391,7 +391,7 @@ export class Logger {
      * Note: This method ignores the configured log level - it always outputs regardless of
      * whether the logger is set to 'off' or any other level.
      *
-     * @param args Values to log directly to console
+     * @param args - values to log directly to console
      */
     raw(...args) {
         this.console.log(...args);

package/dist/map.d.ts

@@ -1,6 +1,6 @@
 /**
  * Sorts a map by `comparator`, a function that compares two entries,
- * defaulting to using `localCompare` and `>`.
+ * defaulting to using `localeCompare` and `>`.
  */
 export declare const sort_map: <T extends Map<any, any>>(map: T, comparator?: (a: [any, any], b: [any, any]) => number) => T;
 /**

package/dist/map.js

@@ -1,6 +1,6 @@
 /**
  * Sorts a map by `comparator`, a function that compares two entries,
- * defaulting to using `localCompare` and `>`.
+ * defaulting to using `localeCompare` and `>`.
  */
 export const sort_map = (map, comparator = compare_simple_map_entries) => new Map([...map].sort(comparator));
 /**

package/dist/object.d.ts

@@ -23,7 +23,7 @@ export declare const pick_by: <T extends Record<K, any>, K extends string | numb
  * `omit_undefined` is a commonly used form of `pick_by`.
  * See this issue for why it's used so much:
  * https://github.com/Microsoft/TypeScript/issues/13195
- * @param obj
+ * @param obj - the object to filter
  * @returns `obj` with all `undefined` properties removed
  */
 export declare const omit_undefined: <T extends Record<string | number, any>>(obj: T) => T;

package/dist/object.js

@@ -45,7 +45,7 @@ export const pick_by = (obj, should_pick) => {
  * `omit_undefined` is a commonly used form of `pick_by`.
  * See this issue for why it's used so much:
  * https://github.com/Microsoft/TypeScript/issues/13195
- * @param obj
+ * @param obj - the object to filter
  * @returns `obj` with all `undefined` properties removed
  */
 export const omit_undefined = (obj) => pick_by(obj, (v) => v !== undefined);

package/dist/package_json.d.ts

@@ -31,7 +31,7 @@ export type PackageJsonExports = z.infer<typeof PackageJsonExports>;
  */
 export declare const PackageJson: z.ZodObject<{
     name: z.ZodString;
-    version: z.ZodString;
+    version: z.ZodOptional<z.ZodString>;
     private: z.ZodOptional<z.ZodBoolean>;
     description: z.ZodOptional<z.ZodString>;
     tagline: z.ZodOptional<z.ZodString>;

package/dist/package_json.js

@@ -49,7 +49,7 @@ export const PackageJsonExports = z.union([
 export const PackageJson = z.looseObject({
     // according to the npm docs, `name` and `version` are the only required properties
     name: z.string(),
-    version: z.string(),
+    version: z.string().optional(),
     private: z
         .boolean()
         .meta({ description: 'disallow publishing to the configured registry' })

package/dist/path.d.ts

@@ -65,15 +65,15 @@ export declare const parse_path_pieces: (raw_path: string) => Array<PathPiece>;
  * Returns `false` when `filename` is `undefined`, empty string, or `exclude` is empty.
  * String patterns use substring matching. RegExp patterns use `.test()`.
  *
- * @param filename The file path to check, or `undefined` for virtual files.
- * @param exclude Array of string or RegExp exclusion patterns.
- * @returns `true` if the file should be excluded from processing.
+ * @param filename - the file path to check, or `undefined` for virtual files
+ * @param exclude - array of string or RegExp exclusion patterns
+ * @returns `true` if the file should be excluded from processing
  */
 export declare const should_exclude_path: (filename: string | undefined, exclude: Array<string | RegExp>) => boolean;
 /**
  * Converts a string into a URL-compatible slug.
- * @param str the string to convert
- * @param map_special_characters if `true`, characters like `ñ` are converted to their ASCII equivalents, runs around 5x faster when disabled
+ * @param str - the string to convert
+ * @param map_special_characters - if `true`, characters like `ñ` are converted to their ASCII equivalents, runs around 5x faster when disabled
  * @mutates special_char_mappers - calls `get_special_char_mappers()` which lazily initializes the module-level array if `map_special_characters` is true
  */
 export declare const slugify: (str: string, map_special_characters?: boolean) => string;

package/dist/path.js

@@ -54,9 +54,9 @@ export const parse_path_pieces = (raw_path) => {
  * Returns `false` when `filename` is `undefined`, empty string, or `exclude` is empty.
  * String patterns use substring matching. RegExp patterns use `.test()`.
  *
- * @param filename The file path to check, or `undefined` for virtual files.
- * @param exclude Array of string or RegExp exclusion patterns.
- * @returns `true` if the file should be excluded from processing.
+ * @param filename - the file path to check, or `undefined` for virtual files
+ * @param exclude - array of string or RegExp exclusion patterns
+ * @returns `true` if the file should be excluded from processing
  */
 export const should_exclude_path = (filename, exclude) => {
     if (!filename || exclude.length === 0)
@@ -65,8 +65,8 @@ export const should_exclude_path = (filename, exclude) => {
 };
 /**
  * Converts a string into a URL-compatible slug.
- * @param str the string to convert
- * @param map_special_characters if `true`, characters like `ñ` are converted to their ASCII equivalents, runs around 5x faster when disabled
+ * @param str - the string to convert
+ * @param map_special_characters - if `true`, characters like `ñ` are converted to their ASCII equivalents, runs around 5x faster when disabled
  * @mutates special_char_mappers - calls `get_special_char_mappers()` which lazily initializes the module-level array if `map_special_characters` is true
  */
 export const slugify = (str, map_special_characters = true) => {

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