@dereekb/util 13.11.14 → 13.11.15

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

@@ -8,14 +8,15 @@ import { type EqualityComparatorFunction } from '../value/comparator';
  * Returns `true` if both arrays have the same length and produce identical key sets.
  * Handles `null`/`undefined` inputs via {@link safeEqualityComparatorFunction}.
  *
+ * @param readKey - Function to extract one or more keys from each object.
+ * @returns An equality comparator for arrays of keyed objects.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilKind factory
  * @dbxUtilTags object, key, equality, comparator, factory, array
  * @dbxUtilRelated object-key-equality-comparator-function, safe-equality-comparator-function
  *
- * @param readKey - Function to extract one or more keys from each object
- * @returns An equality comparator for arrays of keyed objects
  * @__NO_SIDE_EFFECTS__
  */
 export declare function objectKeysEqualityComparatorFunction<T, K extends PrimativeKey = PrimativeKey>(readKey: ReadKeyFunction<T, K> | ReadMultipleKeysFunction<T, K>): EqualityComparatorFunction<Maybe<T[]>>;
@@ -25,14 +26,15 @@ export declare function objectKeysEqualityComparatorFunction<T, K extends Primat
  *
  * Handles `null`/`undefined` inputs via {@link safeEqualityComparatorFunction}.
  *
+ * @param readKey - Function to extract the key from an object.
+ * @returns An equality comparator for keyed objects.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilKind factory
  * @dbxUtilTags object, key, equality, comparator, factory
  * @dbxUtilRelated object-keys-equality-comparator-function, safe-equality-comparator-function
  *
- * @param readKey - Function to extract the key from an object
- * @returns An equality comparator for keyed objects
  * @__NO_SIDE_EFFECTS__
  */
 export declare function objectKeyEqualityComparatorFunction<T, K extends PrimativeKey = PrimativeKey>(readKey: ReadKeyFunction<T, K>): EqualityComparatorFunction<Maybe<T>>;

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

@@ -21,8 +21,8 @@ export type MappedObjectMap<M extends object, O> = {
 /**
  * Converts an {@link ObjectMap} into a `Map` using `Object.entries`.
  *
- * @param object - The object map to convert
- * @returns A `Map` with the same key-value pairs
+ * @param object - The object map to convert.
+ * @returns A `Map` with the same key-value pairs.
  */
 export declare function objectToMap<T>(object: ObjectMap<T>): Map<string, T>;
 /**
@@ -32,14 +32,15 @@ export type MapObjectMapFunction<M extends ObjectMap<I>, I = unknown, O = unknow
 /**
  * Creates a reusable {@link MapObjectMapFunction} that applies {@link mapObjectMap} with the given mapping function.
  *
+ * @param mapFn - Function that transforms each value (receives value and key)
+ * @returns Maps all values in an input object map.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilKind factory
  * @dbxUtilTags object, map, transform, factory, values
  * @dbxUtilRelated map-object-map, map-object-keys-function
  *
- * @param mapFn - Function that transforms each value (receives value and key)
- * @returns A function that maps all values in an input object map
  * @__NO_SIDE_EFFECTS__
  */
 export declare function mapObjectMapFunction<M extends ObjectMap<I>, I = unknown, O = unknown>(mapFn: MapObjectMapValueFunction<M, I, O>): MapObjectMapFunction<M, I, O>;
@@ -50,18 +51,18 @@ export type MapObjectMapValueFunction<M extends ObjectMap<I>, I = unknown, O = u
 /**
  * Maps all values of an {@link ObjectMap} from one type to another, returning a new object with the same keys.
  *
- * @param object - The source object map
- * @param mapFn - Function that transforms each value
- * @returns A new object with mapped values
+ * @param object - The source object map.
+ * @param mapFn - Function that transforms each value.
+ * @returns A new object with mapped values.
  */
 export declare function mapObjectMap<M extends ObjectMap<I>, I = unknown, O = unknown>(object: M, mapFn: MapObjectMapValueFunction<M, I, O>): MappedObjectMap<M, O>;
 /**
  * Maps the values of a source {@link ObjectMap} and assigns the results onto the target object, returning the target.
  *
- * @param object - The source object map
- * @param target - The target object to assign mapped values onto
- * @param mapFn - Function that transforms each value
- * @returns The target object with mapped values assigned
+ * @param object - The source object map.
+ * @param target - The target object to assign mapped values onto.
+ * @param mapFn - Function that transforms each value.
+ * @returns The target object with mapped values assigned.
  */
 export declare function mapObjectToTargetObject<M extends ObjectMap<I>, I = unknown, O = unknown>(object: M, target: MappedObjectMap<M, O>, mapFn: MapObjectMapValueFunction<M, I, O>): MappedObjectMap<M, O>;
 /**
@@ -75,14 +76,15 @@ export type MapObjectKeyFunction<M> = <K extends keyof M>(key: K, value: M[K]) =
 /**
  * Creates a reusable {@link MapObjectKeysFunction} that transforms the keys of an input object using the given mapping function.
  *
+ * @param mapKeyFn - Function that computes the new key from the old key and its value.
+ * @returns Remaps keys on any input object.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilKind factory
  * @dbxUtilTags object, map, keys, transform, factory, rename
  * @dbxUtilRelated map-object-map-function, map-object-keys-to-lowercase
  *
- * @param mapKeyFn - Function that computes the new key from the old key and its value
- * @returns A function that remaps keys on any input object
  * @__NO_SIDE_EFFECTS__
  */
 export declare function mapObjectKeysFunction<M extends object>(mapKeyFn: MapObjectKeyFunction<M>): MapObjectKeysFunction<M>;

package/src/lib/page/page.d.ts

@@ -32,21 +32,21 @@ export interface Page {
 /**
  * Extracts the page number from a {@link Page} object, returning {@link UNLOADED_PAGE} if the input is nullish.
  *
- * @param page - Page object to read from
- * @returns The page number, or {@link UNLOADED_PAGE} (-1) if not provided
+ * @param page - Page object to read from.
+ * @returns The page number, or {@link UNLOADED_PAGE} (-1) if not provided.
  */
 export declare function getPageNumber(page: Maybe<Partial<Page>>): number;
 /**
  * Returns the next sequential page number after the given page.
  *
- * @param page - Current page object
- * @returns The current page number plus one
+ * @param page - Current page object.
+ * @returns The current page number plus one.
  */
 export declare function getNextPageNumber(page: Maybe<Partial<Page>>): number;
 /**
  * Checks whether the given page represents the final page of results.
  *
- * @param page - Page object to check
+ * @param page - Page object to check.
  * @returns `true` if the page number equals {@link FINAL_PAGE}
  */
 export declare function isFinalPage(page: Maybe<Partial<Page>>): boolean;

package/src/lib/page/page.filter.d.ts

@@ -28,9 +28,9 @@ export interface FilteredPageIterateFn<T> {
 /**
  * Creates a {@link FilteredPage} combining a page number with an optional filter copied from the request.
  *
- * @param page - The page number
- * @param request - Optional filter to copy into the result
- * @returns A new filtered page object
+ * @param page - The page number.
+ * @param request - Optional filter to copy into the result.
+ * @returns A new filtered page object.
  */
 export declare function filteredPage<F = unknown>(page: PageNumber, request?: Filter<F>): FilteredPage<F>;
 /**
@@ -39,10 +39,10 @@ export declare function filteredPage<F = unknown>(page: PageNumber, request?: Fi
  * Starts from the given page and increments the page number after each load. Stops when
  * `loadFn` returns an empty array. Either `iterFn.use` or `iterFn.usePage` must be provided.
  *
- * @param inputPage - Starting page with optional filter
- * @param loadFn - Async function that loads a page of results
- * @param iterFn - Callbacks for processing each item or page
- * @returns The total number of items processed across all pages
- * @throws Error if neither `use` nor `usePage` is specified in `iterFn`
+ * @param inputPage - Starting page with optional filter.
+ * @param loadFn - Async function that loads a page of results.
+ * @param iterFn - Callbacks for processing each item or page.
+ * @returns The total number of items processed across all pages.
+ * @throws {Error} If neither `use` nor `usePage` is specified in `iterFn`
  */
 export declare function iterateFilteredPages<T, F>(inputPage: FilteredPage<F>, loadFn: (page: FilteredPage<F>) => Promise<T[]>, iterFn: FilteredPageIterateFn<T>): Promise<number>;

package/src/lib/path/path.d.ts

@@ -124,85 +124,85 @@ export type SlashPathType = 'folder' | 'file' | 'typedfile' | 'invalid';
 /**
  * Determines the type of a slash path string.
  *
+ * @param input - The slash path to classify.
+ * @returns The path type classification.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, type, classify, file, folder, typed, detect
  * @dbxUtilRelated is-slash-path-file, is-slash-path-folder, is-slash-path-typed-file, is-valid-slash-path
- *
- * @param input - The slash path to classify.
- * @returns The path type classification.
  */
 export declare function slashPathType(input: SlashPath): SlashPathType;
 /**
  * Type guard that checks if the input is a file path (typed or untyped).
  *
+ * @param input - The string to check.
+ * @returns Whether the input is a file path.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, file, type-guard, predicate, check, is
  * @dbxUtilRelated is-slash-path-typed-file, is-slash-path-folder, slash-path-type
- *
- * @param input - The string to check.
- * @returns Whether the input is a file path.
  */
 export declare function isSlashPathFile(input: string): input is SlashPathFile;
 /**
  * Type guard that checks if the input is a typed file path (contains a file extension).
  *
+ * @param input - The string to check.
+ * @returns Whether the input is a typed file path.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, file, extension, type-guard, predicate, typed
  * @dbxUtilRelated is-slash-path-file, is-slash-path-folder, slash-path-type
- *
- * @param input - The string to check.
- * @returns Whether the input is a typed file path.
  */
 export declare function isSlashPathTypedFile(input: string): input is SlashPathTypedFile;
 /**
  * Type guard that checks if the input is a folder path (ends with a slash).
  *
+ * @param input - The string to check.
+ * @returns Whether the input is a folder path.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, folder, directory, type-guard, predicate, trailing
  * @dbxUtilRelated is-slash-path-file, is-valid-slash-path, slash-path-type
- *
- * @param input - The string to check.
- * @returns Whether the input is a folder path.
  */
 export declare function isSlashPathFolder(input: string): input is SlashPathFolder;
 /**
  * Type guard that checks if the input is a valid slash path (not 'invalid' type).
  *
+ * @param input - The string to check.
+ * @returns Whether the input is a valid slash path.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, valid, type-guard, predicate, check, validate
  * @dbxUtilRelated slash-path-type, slash-path-validation-factory, slash-path-invalid-error
- *
- * @param input - The string to check.
- * @returns Whether the input is a valid slash path.
  */
 export declare function isValidSlashPath(input: string): input is SlashPath;
 /**
  * Returns the last part of the slash path.
  *
+ * @param slashPath - The path to extract the name from.
+ * @returns The last part of the path (file name or folder name).
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, name, last, basename, leaf, file, folder
  * @dbxUtilRelated slash-path-parts, slash-path-details, isolate-slash-path
- *
- * @param slashPath - The path to extract the name from.
- * @returns The last part of the path (file name or folder name).
  */
 export declare function slashPathName(slashPath: SlashPath): SlashPathPart;
 /**
  * Returns each section of a SlashPath.
  *
+ * @param slashPath - The path to split.
+ * @returns Array of non-empty path segments.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, split, parts, segments, sections, components
  * @dbxUtilRelated slash-path-name, slash-path-details, isolate-slash-path
- *
- * @param slashPath - The path to split.
- * @returns Array of non-empty path segments.
  */
 export declare function slashPathParts(slashPath: SlashPath): SlashPathPart[];
 /**
@@ -219,14 +219,15 @@ export type SlashPathStartTypeFactory = SlashPathFunction;
 /**
  * Creates a function that enforces the specified start type on a slash path.
  *
+ * @param type - The start type to enforce.
+ * @returns Transforms paths to the specified start type.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilKind factory
  * @dbxUtilTags path, slash, factory, start-type, relative, absolute, normalize
  * @dbxUtilRelated to-relative-slash-path-start-type, to-absolute-slash-path-start-type, slash-path-factory
  *
- * @param type - The start type to enforce.
- * @returns A function that transforms paths to the specified start type.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function slashPathStartTypeFactory(type: SlashPathStartType): SlashPathStartTypeFactory;
@@ -239,13 +240,13 @@ export declare const ALL_SLASH_PATH_FILE_TYPE_SEPARATORS_REGEX: RegExp;
 /**
  * Converts a slash path to a relative path by removing all leading slashes.
  *
+ * @param input - The slash path to convert.
+ * @returns A relative path without leading slashes.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, relative, leading, strip, normalize, convert
  * @dbxUtilRelated to-absolute-slash-path-start-type, slash-path-start-type-factory
- *
- * @param input - The slash path to convert.
- * @returns A relative path without leading slashes.
  */
 export declare function toRelativeSlashPathStartType(input: SlashPath): SlashPath;
 /**
@@ -279,14 +280,15 @@ export interface SlashPathFolderFactoryConfig {
 /**
  * Creates a SlashPathFolderFactory.
  *
+ * @param config - Configuration options for the factory.
+ * @returns A SlashPathFolderFactory.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilKind factory
  * @dbxUtilTags path, slash, folder, factory, validate, normalize, trailing-slash
  * @dbxUtilRelated slash-path-folder, slash-path-validation-factory, add-trailing-slash
  *
- * @param config Configuration options for the factory.
- * @returns A SlashPathFolderFactory.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function slashPathFolderFactory(config?: SlashPathFolderFactoryConfig): SlashPathFolderFactory;
@@ -295,113 +297,114 @@ export declare function slashPathFolderFactory(config?: SlashPathFolderFactoryCo
  *
  * If the input is a file, the folder of the file is returned instead.
  *
+ * @param input - The string path to convert to a folder path.
+ * @param config - Optional configuration controlling path type inference and invalid-path handling.
+ * @returns A valid slash path folder string with a trailing slash, or an empty string for relative root.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, folder, convert, normalize, validate, directory
  * @dbxUtilRelated slash-path-folder-factory, slash-path-details, add-trailing-slash
- *
- * @param input - the string path to convert to a folder path
- * @param config - optional configuration controlling path type inference and invalid-path handling
- * @returns a valid slash path folder string with a trailing slash, or an empty string for relative root
  */
 export declare function slashPathFolder(input: string, config?: SlashPathFolderFactoryConfig): InferredSlashPathFolder;
 /**
  * Converts a slash path to an absolute path by ensuring exactly one leading slash.
  *
+ * @param input - The slash path to convert.
+ * @returns An absolute path starting with a single slash.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, absolute, leading, prefix, normalize, convert
  * @dbxUtilRelated to-relative-slash-path-start-type, slash-path-start-type-factory, fix-multi-slashes-in-slash-path
- *
- * @param input - The slash path to convert.
- * @returns An absolute path starting with a single slash.
  */
 export declare function toAbsoluteSlashPathStartType(input: SlashPath): SlashPath;
 /**
  * Replaces consecutive double slashes with single slashes.
  *
+ * @param input - The slash path to fix.
+ * @returns The path with double slashes collapsed.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, fix, collapse, double, normalize, dedupe
  * @dbxUtilRelated merge-slash-paths, replace-multiple-file-paths-in-slash-path
- *
- * @param input - The slash path to fix.
- * @returns The path with double slashes collapsed.
  */
 export declare function fixMultiSlashesInSlashPath(input: SlashPath): SlashPath;
 /**
  * Replaces consecutive double slashes with single slashes. Alias for {@link fixMultiSlashesInSlashPath}.
  *
+ * @param input - The slash path to fix.
+ * @returns The path with double slashes collapsed.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, alias, collapse, double, normalize
  * @dbxUtilRelated fix-multi-slashes-in-slash-path, merge-slash-paths
- *
- * @param input - The slash path to fix.
- * @returns The path with double slashes collapsed.
  */
 export declare function replaceMultipleFilePathsInSlashPath(input: SlashPath): SlashPath;
 /**
  * Removes all trailing slashes from a slash path.
  *
+ * @param input - The slash path to trim.
+ * @returns The path without trailing slashes.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, trim, trailing, strip, remove, normalize
  * @dbxUtilRelated add-trailing-slash, remove-trailing-file-type-separators
- *
- * @param input - The slash path to trim.
- * @returns The path without trailing slashes.
  */
 export declare function removeTrailingSlashes(input: SlashPath): SlashPath;
 /**
  * Removes all trailing dots from a slash path.
  *
+ * @param input - The slash path to trim.
+ * @returns The path without trailing dots.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, trim, trailing, dot, file-type, strip, normalize
  * @dbxUtilRelated remove-trailing-slashes, replace-invalid-file-path-type-separators-in-slash-path
- *
- * @param input - The slash path to trim.
- * @returns The path without trailing dots.
  */
 export declare function removeTrailingFileTypeSeparators(input: SlashPath): SlashPath;
 /**
  * Adds a trailing slash to the input if it does not already have one.
  *
+ * @param input - A slash path.
+ * @returns A slash path folder.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, trailing, append, folder, ensure, normalize
  * @dbxUtilRelated remove-trailing-slashes, slash-path-folder, slash-path-folder-factory
- *
- * @param input A slash path.
- * @returns A slash path folder.
  */
 export declare function addTrailingSlash(input: SlashPath): SlashPathFolder;
 /**
  * Replaces all extra and invalidate FilePathTypeSeparator values from the SlashPath, returning a valid SlashPath.
  *
+ * @param input
+ * @param replaceWith
+ * @returns
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, dot, file-type, replace, sanitize, fix, validate
  * @dbxUtilRelated replace-invalid-file-path-type-separators-in-slash-path-function, slash-path-validation-factory
- *
- * @param input
- * @param replaceWith
- * @returns
  */
 export declare function replaceInvalidFilePathTypeSeparatorsInSlashPath(input: SlashPath, replaceWith?: string): SlashPath;
 /**
  * Creates a function that replaces all extra and invalidate FilePathTypeSeparator values from the SlashPath, returning a valid SlashPath.
  *
+ * @param replaceWith
+ * @param input
+ * @returns
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilKind factory
  * @dbxUtilTags path, slash, dot, file-type, factory, replace, sanitize, validate
  * @dbxUtilRelated replace-invalid-file-path-type-separators-in-slash-path, slash-path-validation-factory
  *
- * @param input
- * @param replaceWith
- * @returns
  * @__NO_SIDE_EFFECTS__
  */
 export declare function replaceInvalidFilePathTypeSeparatorsInSlashPathFunction(replaceWith?: string): SlashPathFunction;
@@ -436,14 +439,15 @@ export interface SlashPathValidationFactoryConfig {
 /**
  * Creates a validation/fixup function for slash paths that replaces illegal characters and extra dots.
  *
+ * @param config - Configuration for validation behavior.
+ * @returns Validates and fixes a slash path.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilKind factory
  * @dbxUtilTags path, slash, validate, factory, sanitize, illegal, replace, fix
  * @dbxUtilRelated is-valid-slash-path, replace-invalid-file-path-type-separators-in-slash-path-function, slash-path-factory, slash-path-invalid-error
  *
- * @param config - Configuration for validation behavior.
- * @returns A function that validates and fixes a slash path.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function slashPathValidationFactory(config?: SlashPathValidationFactoryConfig): SlashPathValidationFactory;
@@ -468,51 +472,52 @@ export interface SlashPathFactoryConfig {
 /**
  * Creates a factory function that merges path segments together with optional base path, start type enforcement, and validation.
  *
+ * @param config - Configuration for path generation.
+ * @returns A factory function that merges input paths into a single validated slash path.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilKind factory
  * @dbxUtilTags path, slash, factory, merge, base, start-type, validate, normalize
  * @dbxUtilRelated merge-slash-paths, slash-path-validation-factory, slash-path-start-type-factory
  *
- * @param config - Configuration for path generation.
- * @returns A factory function that merges input paths into a single validated slash path.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function slashPathFactory(config?: SlashPathFactoryConfig): SlashPathFactory;
 /**
  * Merges an array of path segments into a single slash path, filtering nullish values and collapsing double slashes.
  *
+ * @param paths - Array of path segments to merge.
+ * @returns The merged slash path.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, merge, join, concat, segments, normalize, dedupe
  * @dbxUtilRelated slash-path-factory, fix-multi-slashes-in-slash-path, slash-path-parts
- *
- * @param paths - Array of path segments to merge.
- * @returns The merged slash path.
  */
 export declare function mergeSlashPaths(paths: Maybe<SlashPath>[]): SlashPath;
 /**
  * Creates an Error indicating that a slash path is invalid.
  *
+ * @returns A new Error with a descriptive message.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, error, invalid, throw, validate
  * @dbxUtilRelated is-valid-slash-path, slash-path-validation-factory
- *
- * @returns A new Error with a descriptive message.
  */
 export declare function slashPathInvalidError(): Error;
 /**
  * Splits the path and returns the items at the given ranges.
  *
+ * @param path - The path to isolate parts from.
+ * @param range - Index range defining which path segments to extract.
+ * @returns A new slash path containing only the segments within the range.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, isolate, slice, range, segments, extract, sub-path
  * @dbxUtilRelated isolate-slash-path-function, slash-path-parts, slash-path-details
- *
- * @param path - The path to isolate parts from.
- * @param range - Index range defining which path segments to extract.
- * @returns A new slash path containing only the segments within the range.
  */
 export declare function isolateSlashPath(path: SlashPath, range: IndexRangeInput): SlashPath;
 /**
@@ -541,14 +546,15 @@ export type IsolateSlashPathFunction = (path: SlashPath) => SlashPath;
 /**
  * Creates an IsolateSlashPathFunction.
  *
+ * @param config - Configuration with range, optional start type, and file mode.
+ * @returns Isolates path segments within the configured range.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilKind factory
  * @dbxUtilTags path, slash, isolate, factory, slice, range, segments, sub-path
  * @dbxUtilRelated isolate-slash-path, slash-path-parts, slash-path-details
  *
- * @param config - Configuration with range, optional start type, and file mode.
- * @returns A function that isolates path segments within the configured range.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function isolateSlashPathFunction(config: IsolateSlashPathFunctionConfig): IsolateSlashPathFunction;
@@ -619,13 +625,13 @@ export interface SlashPathDetails {
 /**
  * Returns the details of a path.
  *
+ * @param path - The path to get details for.
+ * @returns The details of the path.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, details, parse, decompose, file, folder, extension, parts
  * @dbxUtilRelated slash-path-type, slash-path-parts, slash-path-folder, slash-path-name
- *
- * @param path The path to get details for.
- * @returns The details of the path.
  */
 export declare function slashPathDetails(path: SlashPath): SlashPathDetails;
 /**
@@ -654,13 +660,14 @@ export type SlashPathPathMatcherPath = ArrayOrValue<SlashPathPathMatcherPart>;
 /**
  * Expands the input matcher path into decision functions.
  *
+ * @param path - Matcher path parts to expand into decision functions.
+ * @returns Array of decision functions for each path part.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, matcher, expand, decision, predicate, wildcard, build
  * @dbxUtilRelated slash-path-path-matcher, slash-path-sub-path-matcher, slash-path-path-matcher-config
  *
- * @param path - Matcher path parts to expand into decision functions.
- * @returns Array of decision functions for each path part.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function expandSlashPathPathMatcherPartToDecisionFunctions(path: SlashPathPathMatcherPath): SlashPathPathMatcherFunction[];
@@ -709,7 +716,7 @@ export interface SlashPathPathMatcherResult<N extends PrimativeValue = typeof DE
      *
      * The array element is null on parts that do not match.
      */
-    readonly matchingParts: (SlashPathPart | null)[];
+    readonly matchingParts: Maybe<SlashPathPart>[];
     /**
      * The value to use when filling non-matching parts.
      */
@@ -721,7 +728,7 @@ export interface SlashPathPathMatcherResult<N extends PrimativeValue = typeof DE
      *
      * If the input path is shorter than the target path, the remaining parts will be filled with the nonMatchingFillValue.
      */
-    readonly nonMatchingParts: (SlashPathPart | null | N)[];
+    readonly nonMatchingParts: Maybe<SlashPathPart | N>[];
     /**
      * The total number of parts that did not match.
      */
@@ -731,26 +738,28 @@ export type SlashPathPathMatcherConfigInput<N extends PrimativeValue = Primative
 /**
  * Creates a SlashPathPathMatcherConfig from the input.
  *
+ * @param input - The configuration input.
+ * @returns The configuration.
+ * @throws {Error} When `input` is not an array, string, or config object.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilTags path, slash, matcher, config, normalize, coerce
  * @dbxUtilRelated slash-path-path-matcher, slash-path-sub-path-matcher
- *
- * @param input The configuration input.
- * @returns The configuration.
  */
 export declare function slashPathPathMatcherConfig<N extends PrimativeValue = PrimativeValue>(input: SlashPathPathMatcherConfigInput<N>): SlashPathPathMatcherConfig<N>;
 /**
  * Creates a SlashPathPathMatcher.
  *
+ * @param input - The matcher configuration, which may be a target path string, an array of path parts, or a full config object.
+ * @returns The matcher.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilKind factory
  * @dbxUtilTags path, slash, matcher, factory, predicate, wildcard, target, compare
  * @dbxUtilRelated slash-path-sub-path-matcher, expand-slash-path-path-matcher-part-to-decision-functions, slash-path-path-matcher-config
  *
- * @param input - the matcher configuration, which may be a target path string, an array of path parts, or a full config object
- * @returns The matcher.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function slashPathPathMatcher<N extends PrimativeValue = PrimativeValue>(input: SlashPathPathMatcherConfigInput<N>): SlashPathPathMatcher<N>;
@@ -779,13 +788,13 @@ export interface SlashPathSubPathMatcherBaseResult {
      *
      * The array element is null on parts that match.
      */
-    readonly nonMatchingParts: (SlashPathPart | null)[];
+    readonly nonMatchingParts: Maybe<SlashPathPart>[];
     /**
      * All remaining parts of the path, relative to the base path.
      *
      * Only non-null if matchesBasePath is true.
      */
-    readonly subPathParts: SlashPathPart[] | null;
+    readonly subPathParts: Maybe<SlashPathPart[]>;
 }
 export interface SlashPathSubPathMatcherMatchResult extends SlashPathSubPathMatcherBaseResult {
     readonly matchesBasePath: true;
@@ -808,14 +817,15 @@ export type SlashPathSubPathMatcher = (path: SlashPath) => SlashPathSubPathMatch
 /**
  * Creates a SlashPathSubPathMatcher.
  *
+ * @param config - The configuration for the matcher.
+ * @returns The matcher.
+ *
  * @dbxUtil
  * @dbxUtilCategory path
  * @dbxUtilKind factory
  * @dbxUtilTags path, slash, matcher, sub-path, factory, base-path, prefix, predicate
  * @dbxUtilRelated slash-path-path-matcher, expand-slash-path-path-matcher-part-to-decision-functions
  *
- * @param config The configuration for the matcher.
- * @returns The matcher.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function slashPathSubPathMatcher(config: SlashPathSubPathMatcherConfig): SlashPathSubPathMatcher;