@design-edito/tools 0.4.22 → 0.5.0

package/agnostic/misc/crawler/index.d.ts

@@ -2,29 +2,29 @@
  * Function that fetches content from a URL asynchronously.
  *
  * @template T - The type of content returned by the fetcher.
- * @param {string} url - The URL to fetch.
- * @returns {Promise<T>} A promise resolving to the fetched content.
+ * @param url - The URL to fetch.
+ * @returns A promise resolving to the fetched content.
  */
 export type Fetcher<T> = (url: string) => Promise<T>;
 /**
  * Function that processes fetched content for a given URL.
  *
  * @template T - The type of content provided by the fetcher.
- * @param {string} url - The URL of the content being processed.
- * @param {T} content - The content fetched from the URL.
- * @param {object} hooks - Hooks for accessing crawler state and controlling the crawl.
- * @param {(...urls: string[]) => void} hooks.push - Enqueue one or more URLs to be crawled.
- * @param {() => void} hooks.flush - Clear the waitlist of pending URLs.
- * @param {Set<string>} hooks.processed - Read-only snapshot of URLs already processed.
- * @param {string[]} hooks.waitlist - Read-only snapshot of the current waitlist of URLs.
- * @returns {any} The result of processing (ignored by the crawler).
+ * @param url - The URL of the content being processed.
+ * @param content - The content fetched from the URL.
+ * @param hooks - Hooks for accessing crawler state and controlling the crawl.
+ * @param hooks.push - Enqueue one or more URLs to be crawled.
+ * @param hooks.flush - Clear the waitlist of pending URLs.
+ * @param hooks.processed - Read-only snapshot of URLs already processed.
+ * @param hooks.waitlist - Read-only snapshot of the current waitlist of URLs.
+ * @returns The result of processing (ignored by the crawler).
  */
 export type Processor<T> = (url: string, content: T, hooks: {
     push: (...urls: string[]) => void;
     flush: () => void;
     processed: Set<string>;
     waitlist: string[];
-}) => any;
+}) => unknown;
 /**
  * Configuration options for the crawler.
  *
@@ -61,13 +61,13 @@ export type Crawler = {
  * Creates a sequential crawler with optional delay.
  *
  * @template T - The type of content returned by the fetcher.
- * @param {Options<T>} options - Crawler configuration options.
- * @param {number} options.limit - Maximum number of URLs to process.
- * @param {number | (() => number)} [options.delayMs] - Optional delay between processing URLs, in milliseconds, or a function returning the delay.
- * @param {boolean} [options.allowDuplicates] - Optional, allows fetching and processing a URL that has already been seen.
- * @param {Fetcher<T>} options.fetcher - Function that fetches content for each URL.
- * @param {Processor<T>} options.processor - Function that processes fetched content.
- * @returns {Crawler} An object with methods to start crawling, enqueue URLs, flush the waitlist, and access crawler state.
+ * @param options - Crawler configuration options.
+ * @param options.limit - Maximum number of URLs to process.
+ * @param [options.delayMs] - Optional delay between processing URLs, in milliseconds, or a function returning the delay.
+ * @param [options.allowDuplicates] - Optional, allows fetching and processing a URL that has already been seen.
+ * @param options.fetcher - Function that fetches content for each URL.
+ * @param options.processor - Function that processes fetched content.
+ * @returns An object with methods to start crawling, enqueue URLs, flush the waitlist, and access crawler state.
  *
  * @example
  * ```typescript

package/agnostic/misc/crawler/index.js

@@ -3,13 +3,13 @@ import { wait } from '../../time/wait/index.js';
  * Creates a sequential crawler with optional delay.
  *
  * @template T - The type of content returned by the fetcher.
- * @param {Options<T>} options - Crawler configuration options.
- * @param {number} options.limit - Maximum number of URLs to process.
- * @param {number | (() => number)} [options.delayMs] - Optional delay between processing URLs, in milliseconds, or a function returning the delay.
- * @param {boolean} [options.allowDuplicates] - Optional, allows fetching and processing a URL that has already been seen.
- * @param {Fetcher<T>} options.fetcher - Function that fetches content for each URL.
- * @param {Processor<T>} options.processor - Function that processes fetched content.
- * @returns {Crawler} An object with methods to start crawling, enqueue URLs, flush the waitlist, and access crawler state.
+ * @param options - Crawler configuration options.
+ * @param options.limit - Maximum number of URLs to process.
+ * @param [options.delayMs] - Optional delay between processing URLs, in milliseconds, or a function returning the delay.
+ * @param [options.allowDuplicates] - Optional, allows fetching and processing a URL that has already been seen.
+ * @param options.fetcher - Function that fetches content for each URL.
+ * @param options.processor - Function that processes fetched content.
+ * @returns An object with methods to start crawling, enqueue URLs, flush the waitlist, and access crawler state.
  *
  * @example
  * ```typescript
@@ -31,13 +31,14 @@ import { wait } from '../../time/wait/index.js';
 export function create(options) {
     let ops = 0;
     const waitlist = [];
-    const push = (...urls) => waitlist.push(...urls);
+    const push = (...urls) => { waitlist.push(...urls); };
     const flush = () => { waitlist.length = 0; };
     const processed = new Set();
     const crawl = async (startUrl) => {
         push(startUrl);
         while (waitlist.length > 0 && ops < options.limit) {
-            ops++;
+            ops = ops + 1;
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- waitlist.length > 0 is guaranteed by the while condition above
             const currentUrl = waitlist[0];
             if (!processed.has(currentUrl) || options.allowDuplicates === true) {
                 const content = await options.fetcher(currentUrl);

package/agnostic/misc/crawler/index.test.js

@@ -5,7 +5,7 @@ describe('create', () => {
         const crawler = create({
             limit: 10,
             fetcher: async () => 'content',
-            processor: async () => { }
+            processor: async () => undefined
         });
         expect(crawler).toHaveProperty('crawl');
         expect(crawler).toHaveProperty('push');
@@ -36,7 +36,7 @@ describe('create', () => {
     });
     it('respects delay when provided', async () => {
         const fetcher = vi.fn(async (url) => `content-${url}`);
-        const processor = vi.fn(async () => { });
+        const processor = vi.fn(async () => undefined);
         const startTime = Date.now();
         const crawler = create({ limit: 2, delayMs: 20, fetcher, processor });
         await crawler.crawl('url1');

package/agnostic/misc/crossenv/detect-runtime/index.d.ts

@@ -5,7 +5,7 @@ import { RuntimeName } from '../types.js';
  * Checks for Node.js, Browser, Deno, React Native, Electron,
  * Cloudflare Workers, and AWS Lambda.
  *
- * @returns {RuntimeName | null}
+ * @returns
  * - The detected runtime as a `RuntimeName` enum value.
  * - `null` if the runtime cannot be determined.
  */

package/agnostic/misc/crossenv/detect-runtime/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import { RuntimeName } from '../types.js';
 /**
  * Detects the current JavaScript runtime environment.
@@ -5,37 +6,35 @@ import { RuntimeName } from '../types.js';
  * Checks for Node.js, Browser, Deno, React Native, Electron,
  * Cloudflare Workers, and AWS Lambda.
  *
- * @returns {RuntimeName | null}
+ * @returns
  * - The detected runtime as a `RuntimeName` enum value.
  * - `null` if the runtime cannot be determined.
  */
 export function detectRuntime() {
     /* Node.js */
-    if (typeof process?.versions?.node !== 'undefined')
+    if (process?.versions?.node !== undefined)
         return RuntimeName.NODE;
     /* Browser */
-    if (typeof window?.document !== 'undefined')
+    if (window?.document !== undefined)
         return RuntimeName.BROWSER;
     /* Deno */
-    if (typeof Deno !== 'undefined')
+    if (Deno !== undefined)
         return RuntimeName.DENO;
     /* React Native */
-    if (typeof process !== 'undefined'
+    if (process !== undefined
         && typeof navigator.userAgent === 'string'
         && navigator.userAgent.includes('ReactNative'))
         return RuntimeName.REACT_NATIVE;
     /* Electron */
-    if (typeof process?.versions !== 'undefined'
-        && typeof process.version.electron !== 'undefined')
+    if (process?.versions?.electron !== undefined)
         return RuntimeName.ELECTRON;
     /* Cloudflare Workers */
-    if (typeof self !== 'undefined'
+    if (self !== undefined
         && typeof self.addEventListener === 'function'
-        && typeof Headers !== 'undefined')
+        && Headers !== undefined)
         return RuntimeName.CLOUDFLARE;
     /* AWS Lambda */
-    if (typeof AWS !== 'undefined'
-        && typeof AWS.Lambda !== 'undefined')
+    if (AWS !== undefined)
         return RuntimeName.AWS_LAMBDA;
     /* Other */
     return null;

package/agnostic/misc/crossenv/window/index.d.ts

@@ -1,28 +1,28 @@
-import { type MinimalWindow } from '../types.js';
+import type { MinimalWindow } from '../types.js';
 /**
  * Checks whether a `window` object exists in the current environment.
  *
- * @returns {boolean} `true` if `window` is present, `false` otherwise.
+ * @returns `true` if `window` is present, `false` otherwise.
  */
 export declare function exists(): boolean;
 /**
  * Sets a custom `window` object to be used internally.
  *
- * @param {MinimalWindow | null} customWindow - The window object to set, or `null` to unset.
- * @returns {MinimalWindow | null} The window object that was set.
+ * @param customWindow - The window object to set, or `null` to unset.
+ * @returns The window object that was set.
  */
 export declare function set(customWindow: MinimalWindow | null): MinimalWindow | null;
 /**
  * Resets the internal window reference to the global `window` if it exists,
  * or `null` if no global `window` is available.
  *
- * @returns {MinimalWindow | null} The current internal window object after reset.
+ * @returns The current internal window object after reset.
  */
 export declare function unset(): MinimalWindow | null;
 /**
  * Retrieves the currently set `window` object.
  *
- * @returns {MinimalWindow} The internal window object.
+ * @returns The internal window object.
  * @throws Will throw an error if no window has been set and none exists globally.
  */
 export declare function get(): MinimalWindow;

package/agnostic/misc/crossenv/window/index.js

@@ -1,20 +1,21 @@
 /**
  * Checks whether a `window` object exists in the current environment.
  *
- * @returns {boolean} `true` if `window` is present, `false` otherwise.
+ * @returns `true` if `window` is present, `false` otherwise.
  */
 export function exists() {
     return typeof globalThis !== 'undefined'
         && 'window' in globalThis;
 }
 let _window = exists()
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     ? (globalThis.window ?? null)
     : null;
 /**
  * Sets a custom `window` object to be used internally.
  *
- * @param {MinimalWindow | null} customWindow - The window object to set, or `null` to unset.
- * @returns {MinimalWindow | null} The window object that was set.
+ * @param customWindow - The window object to set, or `null` to unset.
+ * @returns The window object that was set.
  */
 export function set(customWindow) {
     _window = customWindow;
@@ -24,7 +25,7 @@ export function set(customWindow) {
  * Resets the internal window reference to the global `window` if it exists,
  * or `null` if no global `window` is available.
  *
- * @returns {MinimalWindow | null} The current internal window object after reset.
+ * @returns The current internal window object after reset.
  */
 export function unset() {
     if (exists()) {
@@ -38,7 +39,7 @@ export function unset() {
 /**
  * Retrieves the currently set `window` object.
  *
- * @returns {MinimalWindow} The internal window object.
+ * @returns The internal window object.
  * @throws Will throw an error if no window has been set and none exists globally.
  */
 export function get() {

package/agnostic/misc/data-size/index.js

@@ -42,6 +42,7 @@ export class DataSize {
         else if (unit === 'PiB' || unit === 'pebibyte') {
             this.unit = 'pebibyte';
         }
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
         else if (unit === 'EiB' || unit === 'exbibyte') {
             this.unit = 'exbibyte';
         }
@@ -90,6 +91,7 @@ export class DataSize {
             return this.value * 8 * Math.pow(1024, 4);
         if (this.unit === 'pebibyte')
             return this.value * 8 * Math.pow(1024, 5);
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
         if (this.unit === 'exbibyte')
             return this.value * 8 * Math.pow(1024, 6);
         return this.value; // defaults to bits

package/agnostic/misc/index.d.ts

@@ -1,12 +1,12 @@
 export * as assert from './assert/index.js'
 export * as cast from './cast/index.js'
+export * as connection from './connection/index.js'
 export * as crawler from './crawler/index.js'
 export * as crossenv from './crossenv/index.js'
+export * as dataSize from './data-size/index.js'
 export * as isConstructorFunction from './is-constructor-function/index.js'
 export * as isNullish from './is-nullish/index.js'
 export * as logs from './logs/index.js'
 export * as loremIpsum from './lorem-ipsum/index.js'
-export * as connection from './connection/index.js'
-export * as dataSize from './data-size/index.js'
-export * as outcome from './outcome/index.js'
 export * as normalizeExtension from './normalize-extension/index.js'
+export * as outcome from './outcome/index.js'

package/agnostic/misc/index.js

@@ -1,12 +1,12 @@
 export * as assert from './assert/index.js'
 export * as cast from './cast/index.js'
+export * as connection from './connection/index.js'
 export * as crawler from './crawler/index.js'
 export * as crossenv from './crossenv/index.js'
+export * as dataSize from './data-size/index.js'
 export * as isConstructorFunction from './is-constructor-function/index.js'
 export * as isNullish from './is-nullish/index.js'
 export * as logs from './logs/index.js'
 export * as loremIpsum from './lorem-ipsum/index.js'
-export * as connection from './connection/index.js'
-export * as dataSize from './data-size/index.js'
-export * as outcome from './outcome/index.js'
 export * as normalizeExtension from './normalize-extension/index.js'
+export * as outcome from './outcome/index.js'

package/agnostic/misc/is-constructor-function/index.d.ts

@@ -7,7 +7,7 @@ export type ConstructorFunction<T = any> = new (...args: any[]) => T;
 /**
  * Checks whether a given value is a constructor function (i.e., a class or function with a prototype).
  *
- * @param {unknown} input - The value to check.
- * @returns {input is ConstructorFunction} `true` if the input is a constructor function, otherwise `false`.
+ * @param input - The value to check.
+ * @returns `true` if the input is a constructor function, otherwise `false`.
  */
 export declare function isConstructorFunction(input: unknown): input is ConstructorFunction;

package/agnostic/misc/is-constructor-function/index.js

@@ -1,8 +1,9 @@
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access */
 /**
  * Checks whether a given value is a constructor function (i.e., a class or function with a prototype).
  *
- * @param {unknown} input - The value to check.
- * @returns {input is ConstructorFunction} `true` if the input is a constructor function, otherwise `false`.
+ * @param input - The value to check.
+ * @returns `true` if the input is a constructor function, otherwise `false`.
  */
 export function isConstructorFunction(input) {
     return typeof input === 'function'

package/agnostic/misc/is-constructor-function/index.test.js

@@ -14,11 +14,11 @@ describe('isConstructorFunction', () => {
         expect(isConstructorFunction(MyClass)).toBe(true);
     });
     it('returns true for regular functions', () => {
-        function regularFunction() { }
+        const regularFunction = function () { return undefined; };
         expect(isConstructorFunction(regularFunction)).toBe(true);
     });
     it('returns false for arrow functions', () => {
-        const arrowFunction = () => { };
+        const arrowFunction = () => undefined;
         expect(isConstructorFunction(arrowFunction)).toBe(false);
     });
     it('returns false for non-functions', () => {

package/agnostic/misc/is-nullish/index.d.ts

@@ -12,15 +12,15 @@ export type Nullish = null | undefined;
  * Checks whether a value is nullish (`null` or `undefined`).
  *
  * @template T
- * @param {T | Nullish} val - The value to check.
- * @returns {val is Nullish} `true` if the value is nullish, otherwise `false`.
+ * @param val - The value to check.
+ * @returns `true` if the value is nullish, otherwise `false`.
  */
-export declare function isNullish<T>(val: T | Nullish): val is Nullish;
+export declare function isNullish(val: unknown): val is Nullish;
 /**
  * Checks whether a value is not nullish (`null` or `undefined`).
  *
  * @template T
- * @param {T} val - The value to check.
- * @returns {val is Exclude<T, Nullish>} `true` if the value is not nullish, otherwise `false`.
+ * @param val - The value to check.
+ * @returns `true` if the value is not nullish, otherwise `false`.
  */
 export declare function isNotNullish<T>(val: T): val is Exclude<T, Nullish>;

package/agnostic/misc/is-nullish/index.js

@@ -8,18 +8,19 @@ export const nullishValues = [null, undefined];
  * Checks whether a value is nullish (`null` or `undefined`).
  *
  * @template T
- * @param {T | Nullish} val - The value to check.
- * @returns {val is Nullish} `true` if the value is nullish, otherwise `false`.
+ * @param val - The value to check.
+ * @returns `true` if the value is nullish, otherwise `false`.
  */
 export function isNullish(val) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Array.includes() does a strict equality check regardless of this cast; safe for any T
     return nullishValues.includes(val);
 }
 /**
  * Checks whether a value is not nullish (`null` or `undefined`).
  *
  * @template T
- * @param {T} val - The value to check.
- * @returns {val is Exclude<T, Nullish>} `true` if the value is not nullish, otherwise `false`.
+ * @param val - The value to check.
+ * @returns `true` if the value is not nullish, otherwise `false`.
  */
 export function isNotNullish(val) {
     return !isNullish(val);

package/agnostic/misc/logs/index.d.ts

@@ -1,3 +1,3 @@
 export * as logger from './logger/index.js'
-export * as makeTextBlock from './make-text-block/index.js'
 export * as styles from './styles/index.js'
+export * as makeTextBlock from './make-text-block/index.js'

package/agnostic/misc/logs/index.js

@@ -1,3 +1,3 @@
 export * as logger from './logger/index.js'
-export * as makeTextBlock from './make-text-block/index.js'
 export * as styles from './styles/index.js'
+export * as makeTextBlock from './make-text-block/index.js'

package/agnostic/misc/logs/logger/index.js

@@ -12,7 +12,7 @@ class Log {
         this.stack = (new Error().stack ?? '');
     }
     get displayTime() {
-        return this.time.toLocaleDateString('en-US', {
+        return `${this.time.toLocaleDateString('en-US', {
             year: 'numeric',
             month: 'short',
             day: 'numeric',
@@ -20,7 +20,7 @@ class Log {
             hour: 'numeric',
             minute: 'numeric',
             second: 'numeric'
-        }) + `:${this.time.getMilliseconds()}`;
+        })}:${this.time.getMilliseconds()}`;
     }
     get elapsedTimeMs() {
         return (this.time.getTime() - logsTimeOrigin.getTime()) / 1000;

package/agnostic/misc/lorem-ipsum/index.js

@@ -26,7 +26,7 @@ export const words = [
 export const generateSentence = (wordCount) => {
     const resultArr = [];
     let currentWordCound = wordCount;
-    for (let i = 0; i < currentWordCound; i++) {
+    for (let i = 0; i < currentWordCound; i = i + 1) {
         const picked = randomPick(words);
         if (typeof picked === 'string')
             resultArr.push(picked);
@@ -37,8 +37,8 @@ export const generateSentence = (wordCount) => {
     const [firstWord, ...otherWords] = resultArr;
     if (firstWord === undefined)
         return '';
-    const capFirstLetter = firstWord?.charAt(0).toUpperCase();
-    const restOfFirstWord = firstWord?.slice(1);
+    const capFirstLetter = firstWord.charAt(0).toUpperCase();
+    const restOfFirstWord = firstWord.slice(1);
     const sentence = [
         `${capFirstLetter}${restOfFirstWord}`,
         ...otherWords
@@ -47,7 +47,7 @@ export const generateSentence = (wordCount) => {
 };
 export const generateSentences = (sentencesCount, maxSentenceLength = 12, minSentenceLength = 4) => {
     const sentences = [];
-    for (let i = 0; i < sentencesCount; i++) {
+    for (let i = 0; i < sentencesCount; i = i + 1) {
         const length = randomInt(maxSentenceLength, minSentenceLength) ?? 8;
         sentences.push(generateSentence(length));
     }

package/agnostic/misc/normalize-extension/index.d.ts

@@ -4,8 +4,8 @@
  * Converts the extension to lowercase, removes a leading dot if present,
  * and applies alias mapping if defined.
  *
- * @param {string} extWithoutDot - File extension to normalize (may include or omit leading dot).
- * @param {Record<string, string>} [aliasesWithoutDot=defaultAliases] - Optional mapping of aliases to canonical extensions.
- * @returns {string} The normalized file extension, without leading dot.
+ * @param extWithoutDot - File extension to normalize (may include or omit leading dot).
+ * @param [aliasesWithoutDot=defaultAliases] - Optional mapping of aliases to canonical extensions.
+ * @returns The normalized file extension, without leading dot.
  */
 export declare function normalizeExtension(extWithoutDot: string, aliasesWithoutDot?: Record<string, string>): string;

package/agnostic/misc/normalize-extension/index.js

@@ -91,11 +91,11 @@ const defaultAliases = {
  * Converts the extension to lowercase, removes a leading dot if present,
  * and applies alias mapping if defined.
  *
- * @param {string} extWithoutDot - File extension to normalize (may include or omit leading dot).
- * @param {Record<string, string>} [aliasesWithoutDot=defaultAliases] - Optional mapping of aliases to canonical extensions.
- * @returns {string} The normalized file extension, without leading dot.
+ * @param extWithoutDot - File extension to normalize (may include or omit leading dot).
+ * @param [aliasesWithoutDot=defaultAliases] - Optional mapping of aliases to canonical extensions.
+ * @returns The normalized file extension, without leading dot.
  */
 export function normalizeExtension(extWithoutDot, aliasesWithoutDot = defaultAliases) {
-    const cleaned = extWithoutDot.toLowerCase().replace(/^\./, '');
+    const cleaned = extWithoutDot.toLowerCase().replace(/^\./v, '');
     return aliasesWithoutDot[cleaned] ?? cleaned;
 }

package/agnostic/misc/outcome/index.d.ts

@@ -2,10 +2,10 @@
  * Represents a successful outcome.
  *
  * @template Payload - The type of the success payload.
- * @property {true} success - Always `true`.
- * @property {Payload} payload - The success value.
+ * @property success - Always `true`.
+ * @property payload - The success value.
  */
-export type Success<Payload = any> = {
+export type Success<Payload = unknown> = {
     success: true;
     payload: Payload;
 };
@@ -13,10 +13,10 @@ export type Success<Payload = any> = {
  * Represents a failed outcome.
  *
  * @template Error - The type of the error.
- * @property {false} success - Always `false`.
- * @property {Error} error - The error value.
+ * @property success - Always `false`.
+ * @property error - The error value.
  */
-export type Failure<Error = any> = {
+export type Failure<Error = unknown> = {
     success: false;
     error: Error;
 };
@@ -26,21 +26,21 @@ export type Failure<Error = any> = {
  * @template Payload - Type of success payload.
  * @template Error - Type of error.
  */
-export type Either<Payload = any, Error = any> = Success<Payload> | Failure<Error>;
+export type Either<Payload = unknown, Error = unknown> = Success<Payload> | Failure<Error>;
 /**
  * Creates a success outcome with the given payload.
  *
  * @template Payload
- * @param {Payload} payload - The success value.
- * @returns {Success<Payload>} A success outcome object.
+ * @param payload - The success value.
+ * @returns A success outcome object.
  */
 export declare function makeSuccess<Payload>(payload: Payload): Success<Payload>;
 /**
  * Creates a failure outcome with the given error.
  *
  * @template Error
- * @param {Error} error - The error value.
- * @returns {Failure<Error>} A failure outcome object.
+ * @param error - The error value.
+ * @returns A failure outcome object.
  */
 export declare function makeFailure<Error>(error: Error): Failure<Error>;
 /**
@@ -48,9 +48,9 @@ export declare function makeFailure<Error>(error: Error): Failure<Error>;
  *
  * @template Payload
  * @template Error
- * @param {boolean} success - `true` to create a success, `false` to create a failure.
- * @param {Payload | Error} payloadOrError - The payload if success, or the error if failure.
- * @returns {Either<Payload, Error>} The resulting outcome.
+ * @param success - `true` to create a success, `false` to create a failure.
+ * @param payloadOrError - The payload if success, or the error if failure.
+ * @returns The resulting outcome.
  */
 export declare function make<Payload>(success: true, payload: Payload): Success<Payload>;
 export declare function make<Error>(success: false, error: Error): Failure<Error>;

package/agnostic/misc/outcome/index.js

@@ -2,20 +2,22 @@
  * Creates a success outcome with the given payload.
  *
  * @template Payload
- * @param {Payload} payload - The success value.
- * @returns {Success<Payload>} A success outcome object.
+ * @param payload - The success value.
+ * @returns A success outcome object.
  */
 export function makeSuccess(payload) { return { success: true, payload }; }
 /**
  * Creates a failure outcome with the given error.
  *
  * @template Error
- * @param {Error} error - The error value.
- * @returns {Failure<Error>} A failure outcome object.
+ * @param error - The error value.
+ * @returns A failure outcome object.
  */
 export function makeFailure(error) { return { success: false, error }; }
 export function make(success, payloadOrError) {
     return success
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- guaranteed by the overload signatures above; the implementation signature can't express that link
         ? makeSuccess(payloadOrError)
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- guaranteed by the overload signatures above; the implementation signature can't express that link
         : makeFailure(payloadOrError);
 }

package/agnostic/numbers/absolute-modulo/index.d.ts

@@ -1,8 +1,8 @@
 /**
  * Computes the modulo of a number, always returning a non-negative result.
  *
- * @param {number} nbr - The number to modulo.
- * @param {number} modulo - The modulus.
- * @returns {number} The non-negative remainder of `nbr` modulo `modulo`.
+ * @param nbr - The number to modulo.
+ * @param modulo - The modulus.
+ * @returns The non-negative remainder of `nbr` modulo `modulo`.
  */
 export declare function absoluteModulo(nbr: number, modulo: number): number;

package/agnostic/numbers/absolute-modulo/index.js

@@ -1,9 +1,9 @@
 /**
  * Computes the modulo of a number, always returning a non-negative result.
  *
- * @param {number} nbr - The number to modulo.
- * @param {number} modulo - The modulus.
- * @returns {number} The non-negative remainder of `nbr` modulo `modulo`.
+ * @param nbr - The number to modulo.
+ * @param modulo - The modulus.
+ * @returns The non-negative remainder of `nbr` modulo `modulo`.
  */
 export function absoluteModulo(nbr, modulo) {
     return ((nbr % modulo) + modulo) % modulo;

package/agnostic/numbers/approximate-rational/index.d.ts

@@ -4,9 +4,9 @@
  * Uses a naive algorithm that increments the numerator or denominator each round
  * to find the closest approximation. Stops early if an exact match is found.
  *
- * @param {number} target - The decimal number to approximate.
- * @param {number} maxRounds - The maximum number of iterations to perform.
- * @returns {[number, number]} A tuple `[numerator, denominator]` representing the rational approximation.
+ * @param target - The decimal number to approximate.
+ * @param maxRounds - The maximum number of iterations to perform.
+ * @returns A tuple `[numerator, denominator]` representing the rational approximation.
  */
 export declare function approximateRationalDumb(target: number, maxRounds: number): [number, number];
 /**
@@ -15,8 +15,8 @@ export declare function approximateRationalDumb(target: number, maxRounds: numbe
  * Uses the continued fractions algorithm to find the best rational approximation
  * of a decimal number within the specified maximum denominator limit.
  *
- * @param {number} target - The decimal number to approximate.
- * @param {number} [maxDenominator=1000] - The maximum allowed denominator value.
- * @returns {[number, number]} A tuple `[numerator, denominator]` representing the rational approximation.
+ * @param target - The decimal number to approximate.
+ * @param [maxDenominator=1000] - The maximum allowed denominator value.
+ * @returns A tuple `[numerator, denominator]` representing the rational approximation.
  */
 export declare function approximateRational(target: number, maxDenominator?: number): [number, number];