@dereekb/util 13.11.13 → 13.11.15

package/src/lib/set/set.d.ts

@@ -11,20 +11,20 @@ export type AllOrNoneSelection = 'all' | 'none';
 /**
  * Converts an {@link IterableOrValue} into a Set. Strings are treated as single values rather than character iterables.
  *
+ * @param values - The value or iterable to convert.
+ * @returns A new Set containing all values.
+ *
  * @dbxUtil
  * @dbxUtilCategory set
  * @dbxUtilTags set, convert, normalize, ensure, unique, dedupe
  * @dbxUtilRelated add-to-set, iterable-to-set
- *
- * @param values - The value or iterable to convert.
- * @returns A new Set containing all values.
  */
 export declare function asSet<T>(values: IterableOrValue<T>): Set<T>;
 /**
  * Creates a copy of the set, applies the given function to the copy, and returns it.
  *
  * @param set - The set to copy, or null/undefined for an empty set.
- * @param fn - A function to mutate the copied set.
+ * @param fn - Used to mutate the copied set.
  * @returns The modified copy of the set.
  */
 export declare function copySetAndDo<T>(set: Maybe<Set<T>>, fn: (set: Set<T>) => void): Set<T>;
@@ -39,13 +39,13 @@ export declare function addToSetCopy<T>(set: Maybe<Set<T>>, values: Maybe<Iterab
 /**
  * Adds one or more values to the given set in place.
  *
+ * @param set - The set to add values to.
+ * @param values - The value or iterable of values to add.
+ *
  * @dbxUtil
  * @dbxUtilCategory set
  * @dbxUtilTags set, add, mutate, insert, in-place
  * @dbxUtilRelated add-to-set-copy, remove-from-set, toggle-in-set
- *
- * @param set - The set to add values to.
- * @param values - The value or iterable of values to add.
  */
 export declare function addToSet<T>(set: Set<T>, values: Maybe<IterableOrValue<T>>): void;
 /**
@@ -59,13 +59,13 @@ export declare function toggleInSetCopy<T>(set: Set<T>, values: Maybe<IterableOr
 /**
  * Toggles values in the set in place: adds if absent, removes if present.
  *
+ * @param set - The set to modify.
+ * @param values - The values to toggle.
+ *
  * @dbxUtil
  * @dbxUtilCategory set
  * @dbxUtilTags set, toggle, add, remove, mutate, in-place
  * @dbxUtilRelated toggle-in-set-copy, add-to-set, remove-from-set
- *
- * @param set - The set to modify.
- * @param values - The values to toggle.
  */
 export declare function toggleInSet<T>(set: Set<T>, values: Maybe<IterableOrValue<T>>): void;
 /**
@@ -104,7 +104,7 @@ export declare function hasDifferentValues<T>(a: Maybe<Iterable<T>>, b: Maybe<It
  *
  * @param a - First iterable.
  * @param b - Second iterable.
- * @returns An array of values present in only one of the inputs.
+ * @returns The values present in only one of the inputs.
  */
 export declare function symmetricDifferenceArray<T>(a: Maybe<Iterable<T>>, b: Maybe<Iterable<T>>): Maybe<T>[];
 /**
@@ -112,14 +112,14 @@ export declare function symmetricDifferenceArray<T>(a: Maybe<Iterable<T>>, b: Ma
  *
  * @param a - First set.
  * @param b - Second set.
- * @returns An array of values present in only one of the sets.
+ * @returns The values present in only one of the sets.
  */
 export declare function symmetricDifferenceArrayBetweenSets<T>(a: Set<Maybe<T>>, b: Set<Maybe<T>>): Maybe<T>[];
 /**
  * Flattens a two-dimensional array into a Set of unique values.
  *
  * @param array - The nested array to flatten.
- * @returns A Set containing all values from the nested arrays.
+ * @returns Set of unique values pulled from every nested array.
  */
 export declare function flattenArrayToSet<T>(array: T[][]): Set<T>;
 /**
@@ -128,7 +128,7 @@ export declare function flattenArrayToSet<T>(array: T[][]): Set<T>;
  *
  * @param set - The reference set to check membership against.
  * @param values - The values to filter.
- * @returns A Set of values that exist in both inputs.
+ * @returns Intersection between the input values and the reference set.
  */
 export declare function keepFromSetCopy<T>(set: Set<T>, values: Maybe<IterableOrValue<T>>): Set<T>;
 /**
@@ -136,7 +136,7 @@ export declare function keepFromSetCopy<T>(set: Set<T>, values: Maybe<IterableOr
  *
  * @param values - The array to filter.
  * @param set - The set to check membership against.
- * @returns An array of values present in the set.
+ * @returns The values present in the set.
  */
 export declare function keepValuesFromSet<T>(values: T[], set: Set<T>): T[];
 /**
@@ -144,7 +144,7 @@ export declare function keepValuesFromSet<T>(values: T[], set: Set<T>): T[];
  *
  * @param valuesToExclude - The array of values to filter.
  * @param iterable - The iterable of values to exclude.
- * @returns An array of values not found in the iterable.
+ * @returns The values not found in the iterable.
  */
 export declare function excludeValues<T>(valuesToExclude: T[], iterable: Maybe<Iterable<T>>): T[];
 /**
@@ -152,7 +152,7 @@ export declare function excludeValues<T>(valuesToExclude: T[], iterable: Maybe<I
  *
  * @param values - The array to filter.
  * @param set - The set of values to exclude.
- * @returns An array of values not in the set.
+ * @returns The values not in the set.
  */
 export declare function excludeValuesFromSet<T>(values: T[], set: Set<T>): T[];
 /**
@@ -169,7 +169,7 @@ export declare function filterValuesUsingSet<T>(values: T[], set: Set<T>, exclud
  *
  * @param values - The iterable to filter.
  * @param fn - The decision function that determines inclusion.
- * @returns A Set of values that passed the filter.
+ * @returns Set of values for which `fn` returned `true`.
  */
 export declare function filterValuesToSet<T>(values: Iterable<T>, fn: DecisionFunction<T>): Set<T>;
 /**
@@ -198,21 +198,22 @@ export declare function separateValuesToSets<T>(values: Iterable<T>, fn: Decisio
  *
  * @param values - The iterable to map.
  * @param mapFn - The mapping function.
- * @returns A Set of mapped values.
+ * @returns Mapped values collected into a Set (duplicates collapse).
  */
 export declare function mapValuesToSet<I, O>(values: Iterable<I>, mapFn: MapFunction<I, O>): Set<O>;
 /**
  * Creates a {@link SetHasValueFunction} from an {@link IterableOrValue} by first converting it to a Set.
  *
+ * @param iterable - The values to create a set from.
+ * @param exclude - If true, the returned function returns true for values NOT in the set.
+ * @returns Tests membership.
+ *
  * @dbxUtil
  * @dbxUtilCategory set
  * @dbxUtilKind factory
  * @dbxUtilTags set, has, decision, factory, membership, exclude
  * @dbxUtilRelated set-has-value-function, set-includes-function
  *
- * @param iterable - The values to create a set from.
- * @param exclude - If true, the returned function returns true for values NOT in the set.
- * @returns A function that tests membership.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function hasValueFunction<T>(iterable: IterableOrValue<T>, exclude?: boolean): SetHasValueFunction<T>;
@@ -223,15 +224,16 @@ export type SetHasValueFunction<T> = (value: T) => boolean;
 /**
  * Creates a {@link SetHasValueFunction} for the given set. When `exclude` is true, returns the inverse (true for values not in the set).
  *
+ * @param set - The set to check against.
+ * @param exclude - If true, returns true for values NOT in the set.
+ * @returns Tests membership.
+ *
  * @dbxUtil
  * @dbxUtilCategory set
  * @dbxUtilKind factory
  * @dbxUtilTags set, has, decision, factory, membership, exclude
  * @dbxUtilRelated has-value-function, set-includes-function
  *
- * @param set - The set to check against.
- * @param exclude - If true, returns true for values NOT in the set.
- * @returns A function that tests membership.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function setHasValueFunction<T>(set: Set<T>, exclude: boolean): SetHasValueFunction<T>;
@@ -277,16 +279,17 @@ export type SetIncludesFunction<T> = (valuesToFind: IterableOrValue<T>) => boole
 /**
  * Creates a {@link SetIncludesFunction} that checks whether the set includes given values using the specified mode.
  *
+ * @param valuesSet - The reference set.
+ * @param mode - Whether to require 'all' values or 'any' value to be present. Defaults to 'all'.
+ * @param emptyValuesToFindArrayResult - The result when the values to find are empty.
+ * @returns Tests inclusion against the set.
+ *
  * @dbxUtil
  * @dbxUtilCategory set
  * @dbxUtilKind factory
  * @dbxUtilTags set, includes, decision, factory, all, any, mode
  * @dbxUtilRelated has-value-function, set-has-value-function
  *
- * @param valuesSet - The reference set.
- * @param mode - Whether to require 'all' values or 'any' value to be present. Defaults to 'all'.
- * @param emptyValuesToFindArrayResult - The result when the values to find are empty.
- * @returns A function that tests inclusion against the set.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function setIncludesFunction<T>(valuesSet: Set<T>, mode?: SetIncludesMode, emptyValuesToFindArrayResult?: boolean): SetIncludesFunction<T>;
@@ -303,10 +306,10 @@ export declare function setIncludes<T>(valuesSet: Set<T>, valuesToFind: Iterable
 /**
  * Returns false if the input array contains any value from the second array.
  *
- * @param values - the values to check against
- * @param valuesToFind - the values to look for
- * @param emptyValuesToFindArrayResult - result when valuesToFind is empty
- * @returns `true` if none of the valuesToFind are present in values
+ * @param values - The values to check against.
+ * @param valuesToFind - The values to look for.
+ * @param emptyValuesToFindArrayResult - Result when valuesToFind is empty.
+ * @returns `true` if none of the valuesToFind are present in values.
  */
 export declare function containsNoneOfValue<T>(values: IterableOrValue<T>, valuesToFind: IterableOrValue<T>, emptyValuesToFindArrayResult?: boolean): boolean;
 /**
@@ -332,10 +335,10 @@ export declare function setContainsNoneOfValue<T>(valuesSet: Set<T>, valuesToFin
  *
  * If valuesToFind is empty, returns the emptyValuesToFindArrayResult value. Defaults to false.
  *
- * @param values - the values to build a set from and check against
- * @param valuesToFind - the values to search for within the set
- * @param emptyValuesToFindArrayResult - result when valuesToFind is empty; defaults to false
- * @returns `true` if any of the valuesToFind exist in values
+ * @param values - The values to build a set from and check against.
+ * @param valuesToFind - The values to search for within the set.
+ * @param emptyValuesToFindArrayResult - Result when valuesToFind is empty; defaults to false.
+ * @returns `true` if any of the valuesToFind exist in values.
  */
 export declare function containsAnyValue<T>(values: IterableOrValue<T>, valuesToFind: IterableOrValue<T>, emptyValuesToFindArrayResult?: boolean): boolean;
 /**
@@ -343,10 +346,10 @@ export declare function containsAnyValue<T>(values: IterableOrValue<T>, valuesTo
  *
  * If values is empty, returns the emptyValuesToFindArrayResult value. Defaults to false.
  *
- * @param values - the values to check for membership in the set
- * @param valuesToFind - the set to check against
- * @param emptyValuesArrayResult - result when values is empty; defaults to false
- * @returns `true` if any of the values are present in the set
+ * @param values - The values to check for membership in the set.
+ * @param valuesToFind - The set to check against.
+ * @param emptyValuesArrayResult - Result when values is empty; defaults to false.
+ * @returns `true` if any of the values are present in the set.
  */
 export declare function containsAnyValueFromSet<T>(values: IterableOrValue<T>, valuesToFind: Set<T>, emptyValuesArrayResult?: boolean): boolean;
 /**
@@ -354,10 +357,10 @@ export declare function containsAnyValueFromSet<T>(values: IterableOrValue<T>, v
  *
  * If valuesToFind is empty, returns the emptyValuesToFindArrayResult value. Defaults to false.
  *
- * @param valuesSet - the set to check for membership
- * @param valuesToFind - the values to search for in the set
- * @param emptyValuesToFindArrayResult - result when valuesToFind is empty; defaults to false
- * @returns `true` if any of the valuesToFind are present in the set
+ * @param valuesSet - The set to check for membership.
+ * @param valuesToFind - The values to search for in the set.
+ * @param emptyValuesToFindArrayResult - Result when valuesToFind is empty; defaults to false.
+ * @returns `true` if any of the valuesToFind are present in the set.
  */
 export declare function setContainsAnyValue<T>(valuesSet: Set<T>, valuesToFind: IterableOrValue<T>, emptyValuesToFindArrayResult?: boolean): boolean;
 /**
@@ -365,10 +368,10 @@ export declare function setContainsAnyValue<T>(valuesSet: Set<T>, valuesToFind:
  *
  * If valuesToFind is empty, returns the emptyValuesToFindArrayResult value. Defaults to true.
  *
- * @param values - the iterable of values to build a set from
- * @param valuesToFind - the values that must all be present
- * @param emptyValuesArrayResult - result when valuesToFind is empty; defaults to true
- * @returns `true` if all valuesToFind are present in the values set
+ * @param values - The iterable of values to build a set from.
+ * @param valuesToFind - The values that must all be present.
+ * @param emptyValuesArrayResult - Result when valuesToFind is empty; defaults to true.
+ * @returns `true` if all valuesToFind are present in the values set.
  */
 export declare function containsAllValues<T>(values: Iterable<T>, valuesToFind: IterableOrValue<T>, emptyValuesArrayResult?: boolean): boolean;
 /**
@@ -376,25 +379,25 @@ export declare function containsAllValues<T>(values: Iterable<T>, valuesToFind:
  *
  * If valuesToFind is empty, returns the emptyValuesToFindArrayResult value. Defaults to true.
  *
- * @param valuesSet - the set to check for full containment
- * @param valuesToFind - the values that must all be present in the set
- * @param emptyValuesToFindArrayResult - result when valuesToFind is empty; defaults to true
- * @returns `true` if every value in valuesToFind is present in the set
+ * @param valuesSet - The set to check for full containment.
+ * @param valuesToFind - The values that must all be present in the set.
+ * @param emptyValuesToFindArrayResult - Result when valuesToFind is empty; defaults to true.
+ * @returns `true` if every value in valuesToFind is present in the set.
  */
 export declare function setContainsAllValues<T>(valuesSet: Set<T>, valuesToFind: IterableOrValue<T>, emptyValuesToFindArrayResult?: boolean): boolean;
 /**
  * Returns true if both iterables are defined (or are both null/undefined) and have the same values exactly.
  *
- * @param a - first iterable to compare
- * @param b - second iterable to compare
- * @returns `true` if both iterables contain the same unique values, or both are nullish
+ * @param a - First iterable to compare.
+ * @param b - Second iterable to compare.
+ * @returns `true` if both iterables contain the same unique values, or both are nullish.
  */
 export declare function iterablesAreSetEquivalent<T>(a: Maybe<Iterable<T>>, b: Maybe<Iterable<T>>): boolean;
 /**
  * Returns true if both sets are defined (or are both null/undefined) and have the same values exactly.
  *
- * @param a - first set to compare
- * @param b - second set to compare
- * @returns `true` if both sets contain the same values, or both are nullish
+ * @param a - First set to compare.
+ * @param b - Second set to compare.
+ * @returns `true` if both sets contain the same values, or both are nullish.
  */
 export declare function setsAreEquivalent<T>(a: Maybe<Set<T>>, b: Maybe<Set<T>>): boolean;

package/src/lib/set/set.delta.d.ts

@@ -51,24 +51,25 @@ export interface SetDeltaFunctionConfig<T, K extends PrimativeKey = PrimativeKey
     /**
      * Reads the identifying key from each input value.
      */
-    readKey: ReadKeyFunction<T, K>;
+    readonly readKey: ReadKeyFunction<T, K>;
     /**
      * Whether or not the value is modified.
      */
-    isModifiedFunction?: SetValueIsModifiedFunction<T>;
+    readonly isModifiedFunction?: SetValueIsModifiedFunction<T>;
 }
 /**
  * Creates a {@link SetDeltaFunction} that computes the differences between two iterables,
  * identifying which items were added, removed, or unchanged.
  *
+ * @param config - Configuration with the key reader and optional modification detector.
+ * @returns Compares two iterables and returns an array of change pairs.
+ *
  * @dbxUtil
  * @dbxUtilCategory set
  * @dbxUtilKind factory
  * @dbxUtilTags set, delta, diff, factory, change, added, removed
  * @dbxUtilRelated index-delta-group-function, set-has-value-function
  *
- * @param config - Configuration with the key reader and optional modification detector.
- * @returns A function that compares two iterables and returns an array of change pairs.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function setDeltaFunction<T>(config: SetDeltaFunctionConfig<T>): SetDeltaFunction<T>;

package/src/lib/set/set.hashset.d.ts

@@ -7,7 +7,7 @@ export interface HashSetConfig<K extends PrimativeKey, T> {
     /**
      * Extracts the unique key used for equality comparison from each value.
      */
-    readKey: ReadKeyFunction<T, K>;
+    readonly readKey: ReadKeyFunction<T, K>;
 }
 /**
  * Set that is implemented internally using a Map, and input values have their keys read.
@@ -49,19 +49,19 @@ export declare class HashSet<K extends PrimativeKey, T> implements Set<T> {
      * @param key - The key to look up.
      * @returns The value, or undefined.
      */
-    valueForKey(key: Maybe<K>): T | undefined;
+    valueForKey(key: Maybe<K>): Maybe<T>;
     /**
      * Returns key-value entry pairs for each of the given keys. Missing values appear as undefined.
      *
      * @param keys - The keys to look up.
-     * @returns An array of [key, value] tuples.
+     * @returns Array of [key, value] tuples.
      */
     valueKeyEntriesForKeys(keys: Maybe<K>[]): [Maybe<K>, Maybe<T>][];
     /**
      * Returns the values associated with the given keys, omitting keys that have no value.
      *
      * @param keys - The keys to look up.
-     * @returns An array of found values.
+     * @returns The found values.
      */
     valuesForKeys(keys: Maybe<K>[]): T[];
     forEach(callbackfn: (value: T, value2: T, set: Set<T>) => void, thisArg?: unknown): void;
@@ -71,7 +71,7 @@ export declare class HashSet<K extends PrimativeKey, T> implements Set<T> {
     /**
      * Returns all values in the set as an array.
      *
-     * @returns An array of all stored values.
+     * @returns The all stored values.
      */
     valuesArray(): T[];
     get [Symbol.toStringTag](): string;

package/src/lib/set/set.selection.d.ts

@@ -11,26 +11,27 @@ export interface IsSelectedDecisionFunctionConfig<T, K extends PrimativeKey = Pr
     /**
      * Reads the key from the input value.
      */
-    readKey: ReadKeyFunction<T, K>;
+    readonly readKey: ReadKeyFunction<T, K>;
     /**
      * Default value to use if readKey returns no key.
      *
      * Defaults to false.
      */
-    defaultIfKeyNull?: boolean;
+    readonly defaultIfKeyNull?: boolean;
 }
 /**
  * Creates an {@link IsSelectedDecisionFunctionFactory} that produces decision functions
  * checking whether a value's key is included in a set of selected values.
  *
+ * @param config - Configuration with the key reader and default behavior.
+ * @returns A factory that creates decision functions from a set of selected keys.
+ *
  * @dbxUtil
  * @dbxUtilCategory set
  * @dbxUtilKind factory
  * @dbxUtilTags set, selection, decision, predicate, factory, key
  * @dbxUtilRelated is-in-set-decision-function
  *
- * @param config - Configuration with the key reader and default behavior.
- * @returns A factory that creates decision functions from a set of selected keys.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function isSelectedDecisionFunctionFactory<T, K extends PrimativeKey = PrimativeKey>(config: IsSelectedDecisionFunctionConfig<T, K>): IsSelectedDecisionFunctionFactory<T, K>;

package/src/lib/sort.d.ts

@@ -5,7 +5,7 @@ export declare const SORT_VALUE_LESS_THAN: SortComparisonNumber;
 export declare const SORT_VALUE_GREATER_THAN: SortComparisonNumber;
 export declare const SORT_VALUE_EQUAL: SortComparisonNumber;
 /**
- * A number that is the result of comparison two items.
+ * Is the result of comparison two items.
  *
  * In "ascending" order, a value:
  * - smaller than another will return -1 (or less).
@@ -59,14 +59,14 @@ export declare function reverseCompareFn<T>(compareFn: SortDescendingCompareFunc
  *
  * The input comparison function must be in ascending order.
  *
+ * @param ascendingCompareFn - A comparison function that sorts in ascending order.
+ * @param order - The desired sort direction; defaults to 'asc'.
+ * @returns The original function if ascending, or a reversed version if descending.
+ *
  * @dbxUtil
  * @dbxUtilCategory sort
  * @dbxUtilTags sort, order, ascending, descending, compare, direction
  * @dbxUtilRelated reverse-compare-fn, compare-with-mapped-values-function
- *
- * @param ascendingCompareFn - a comparison function that sorts in ascending order
- * @param order - the desired sort direction; defaults to 'asc'
- * @returns the original function if ascending, or a reversed version if descending
  */
 export declare function compareFnOrder<T>(ascendingCompareFn: AscendingSortCompareFunction<T>, order?: SortingOrder): SortCompareFunction<T>;
 /**
@@ -132,15 +132,15 @@ export declare function sortValues<T>(input: SortValuesInput<T>): T[];
  *
  * @param sortRef - Reference containing the sort comparison function.
  * @param sortOnCopyDefault - Whether to sort on a copy by default (default: true).
- * @returns A function that sorts arrays using the configured comparison.
+ * @returns Sorts arrays using the configured comparison.
  */
 export declare function sortValuesFunctionWithSortRef<T>(sortRef: Maybe<Partial<SortCompareFunctionRef<T>>>, sortOnCopyDefault?: boolean): SortValuesFunction<T>;
 /**
  * Creates a SortValuesFunction using the input. If the input is not defined, or it's sort function is not defined, then returns mapIdentityFunction().
  *
- * @param sortRef - optional reference containing the sort comparison function
- * @param sortOnCopyDefault - whether to sort on a copy by default
- * @returns a sort function that sorts arrays, or the identity function if no sort comparison is configured
+ * @param sortRef - Optional reference containing the sort comparison function.
+ * @param sortOnCopyDefault - Whether to sort on a copy by default.
+ * @returns A sort function that sorts arrays, or the identity function if no sort comparison is configured.
  */
 export declare function sortValuesFunctionOrMapIdentityWithSortRef<T>(sortRef: Maybe<Partial<SortCompareFunctionRef<T>>>, sortOnCopyDefault?: boolean): SortValuesFunction<T>;
 /**
@@ -155,7 +155,7 @@ export interface MinAndMax<T> {
     min: T;
     max: T;
 }
-export type MinAndMaxFunctionResult<T> = MinAndMax<T> | null;
+export type MinAndMaxFunctionResult<T> = Maybe<MinAndMax<T>>;
 /**
  * Returns the min and maximum value from the input values.
  *
@@ -166,7 +166,7 @@ export type MinAndMaxFunction<T> = (values: Iterable<T>) => MinAndMaxFunctionRes
  * Creates a {@link MinAndMaxFunction} that finds the minimum and maximum values from an iterable using the provided comparison function.
  *
  * @param compareFn - Ascending sort comparison function used to determine min/max.
- * @returns A function that returns `{ min, max }` or `null` for empty iterables.
+ * @returns Returns `{ min, max }` or `null` for empty iterables.
  *
  * @dbxUtil
  * @dbxUtilCategory sort

package/src/lib/storage/storage.d.ts

@@ -1,3 +1,4 @@
+import { type Maybe } from '../value/maybe.type';
 import { type UnixDateTimeMillisecondsNumber } from '../date/date';
 /**
  * String representation of data that is stored.
@@ -24,7 +25,7 @@ export interface StoredData {
      * The Unix timestamp (in milliseconds) when the data was stored.
      * Undefined if the storage time is not known or not applicable.
      */
-    readonly storedAt: UnixDateTimeMillisecondsNumber | undefined;
+    readonly storedAt: Maybe<UnixDateTimeMillisecondsNumber>;
     /**
      * The actual data stored, as a string.
      */

package/src/lib/storage/storage.error.d.ts

@@ -7,7 +7,7 @@ export declare class StoredDataError extends BaseError {
     /**
      * Creates an instance of StoredDataError.
      *
-     * @param message Optional error message.
+     * @param message - Optional error message.
      */
     constructor(message?: string);
 }
@@ -18,7 +18,7 @@ export declare class DataDoesNotExistError extends StoredDataError {
     /**
      * Creates an instance of DataDoesNotExistError.
      *
-     * @param message Optional error message.
+     * @param message - Optional error message.
      */
     constructor(message?: string);
 }
@@ -32,8 +32,8 @@ export declare class DataIsExpiredError<T> extends StoredDataError {
     /**
      * Creates an instance of DataIsExpiredError.
      *
-     * @param data The expired data, including metadata.
-     * @param message Optional error message. If not provided, a default message will be used.
+     * @param data - The expired data, including metadata.
+     * @param message - Optional error message. If not provided, a default message will be used.
      */
     constructor(data: ReadStoredData<T>, message?: string);
 }

package/src/lib/storage/storage.memory.d.ts

@@ -10,27 +10,27 @@ export declare class MemoryStorageInstance implements StorageObject {
     /**
      * The number of items stored.
      *
-     * @returns the current count of stored key-value pairs
+     * @returns The current count of stored key-value pairs.
      */
     get length(): number;
     /**
      * Returns the key at the given index.
      *
-     * @param index The index of the key to retrieve.
+     * @param index - The index of the key to retrieve.
      * @returns The key string if found, otherwise null.
      */
     key(index: number): string;
     /**
      * Checks if a key exists in the storage.
      *
-     * @param key The key to check.
+     * @param key - The key to check.
      * @returns True if the key exists, false otherwise.
      */
     hasKey(key: string): boolean;
     /**
      * Retrieves an item from storage.
      *
-     * @param key The key of the item to retrieve.
+     * @param key - The key of the item to retrieve.
      * @returns The item string if found, otherwise null or undefined.
      */
     getItem(key: string): Maybe<string>;
@@ -38,14 +38,14 @@ export declare class MemoryStorageInstance implements StorageObject {
      * Sets an item in storage.
      * If the item is null or undefined, the key will be removed.
      *
-     * @param key The key of the item to set.
-     * @param item The item string to store.
+     * @param key - The key of the item to set.
+     * @param item - The item string to store.
      */
     setItem(key: string, item: Maybe<string>): void;
     /**
      * Removes an item from storage.
      *
-     * @param key The key of the item to remove.
+     * @param key - The key of the item to remove.
      */
     removeItem(key: string): void;
     /**

package/src/lib/storage/storage.object.d.ts

@@ -43,7 +43,7 @@ export declare abstract class StorageObject extends SimpleStorageObject {
      * @param index The index of the key to retrieve.
      * @returns The key string if found, otherwise null.
      */
-    abstract key(index: number): string | null;
+    abstract key(index: number): Maybe<string>;
 }
 /**
  * Extended synchronous Class/Interface for storing string values with additional properties.
@@ -60,7 +60,7 @@ export declare abstract class FullStorageObject extends StorageObject {
     /**
      * Removes all items from storage.
      *
-     * @returns An array of keys that were removed.
+     * @returns The keys that were removed.
      */
     abstract removeAll(): string[];
 }
@@ -71,9 +71,9 @@ export declare class StorageObjectUtility {
     /**
      * Retrieves all keys from a StorageObject, optionally filtering by a prefix.
      *
-     * @param storageObject The StorageObject to retrieve keys from.
-     * @param prefix Optional prefix to filter keys by.
-     * @returns An array of StoredDataStorageKey.
+     * @param storageObject - The StorageObject to retrieve keys from.
+     * @param prefix - Optional prefix to filter keys by.
+     * @returns Array of StoredDataStorageKey.
      */
     static allKeysFromStorageObject(storageObject: StorageObject, prefix?: string): StoredDataStorageKey[];
 }

package/src/lib/string/case.d.ts

@@ -12,13 +12,13 @@
  *
  * Empty segments (e.g. leading underscores in `_USER_ID`) are skipped.
  *
+ * @param input - The SCREAMING_SNAKE_CASE input.
+ * @returns The camelCase form.
+ *
  * @dbxUtil
  * @dbxUtilCategory string
  * @dbxUtilTags string, case, camelcase, snakecase, screaming, convert, transform
  * @dbxUtilRelated camel-or-pascal-to-screaming-snake
- *
- * @param input The SCREAMING_SNAKE_CASE input.
- * @returns The camelCase form.
  */
 export declare function screamingSnakeToCamelCase(input: string): string;
 /**
@@ -27,12 +27,12 @@ export declare function screamingSnakeToCamelCase(input: string): string;
  * Each upper-case character (other than the first) is preceded by an
  * underscore, then the whole result is upper-cased.
  *
+ * @param input - The camelCase / PascalCase input.
+ * @returns The SCREAMING_SNAKE_CASE form.
+ *
  * @dbxUtil
  * @dbxUtilCategory string
  * @dbxUtilTags string, case, camelcase, pascalcase, snakecase, screaming, convert, transform
  * @dbxUtilRelated screaming-snake-to-camel-case
- *
- * @param input The camelCase / PascalCase input.
- * @returns The SCREAMING_SNAKE_CASE form.
  */
 export declare function camelOrPascalToScreamingSnake(input: string): string;