@dereekb/util 13.10.8 → 13.11.0

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

@@ -42,6 +42,11 @@ export declare const SPACE_JOINER = " ";
 /**
  * Joins an array of strings into a single string. Trims and omits empty values.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, join, concat, combine, separator, delimiter
+ * @dbxUtilRelated split-join-remainder, join-strings-instance, string-split-join-instance
+ *
  * @param input string or array of strings
  * @param joiner string to join the strings with. Defaults to a comma.
  * @param trim whether or not to trim the strings before joining. Defaults to false.
@@ -53,6 +58,11 @@ export declare function joinStrings(input: ArrayOrValue<Maybe<string>>, joiner?:
  * Splits a string like {@link String.prototype.split}, but joins overflow segments back together
  * instead of discarding them. Useful when you only want to split on the first N-1 occurrences.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, split, limit, separator, parts, segments
+ * @dbxUtilRelated join-strings, string-split-join-instance
+ *
  * @param input - string to split
  * @param separator - delimiter to split on
  * @param limit - maximum number of resulting segments; overflow segments are rejoined with the separator
@@ -175,6 +185,11 @@ export declare const SPACE_STRING_SPLIT_JOIN: StringSplitJoinInstance<SpaceSepar
 /**
  * Converts a string to its lowercase equivalent for case-insensitive comparison.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, lowercase, case, normalize, compare
+ * @dbxUtilRelated capitalize-first-letter, lowercase-first-letter
+ *
  * @param input - string to convert to lowercase
  * @returns the lowercased string, or undefined if the input is undefined
  */
@@ -194,6 +209,11 @@ export declare function addPlusPrefixToNumber(value?: Maybe<number>, prefix?: st
 /**
  * Capitalizes the first letter of the input string.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, capitalize, case, uppercase, first
+ * @dbxUtilRelated lowercase-first-letter, case-insensitive-string
+ *
  * @param value - string to capitalize
  * @returns the input string with its first character uppercased
  */
@@ -201,6 +221,11 @@ export declare function capitalizeFirstLetter(value: string): string;
 /**
  * Lowercases the first letter of the input string.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, lowercase, case, first, decapitalize
+ * @dbxUtilRelated capitalize-first-letter, case-insensitive-string
+ *
  * @param value - string to modify
  * @returns the input string with its first character lowercased
  */
@@ -213,6 +238,11 @@ export type FirstNameLastNameTuple = [string, string | undefined];
  * Splits the input string into a first name and last name tuple using a space as the delimiter.
  * If the name contains more than one space, the remainder is treated as the last name.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, name, split, first, last, person, parse
+ * @dbxUtilRelated split-join-remainder
+ *
  * @param input - full name string to split
  * @returns a tuple of [firstName, lastName], where lastName includes all text after the first space
  */
@@ -220,6 +250,10 @@ export declare function splitJoinNameString(input: string): FirstNameLastNameTup
 /**
  * Creates a string that repeats the given string a specified number of times.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, repeat, build, generate, fill
+ *
  * @param string - the string to repeat
  * @param reapeat - number of times to repeat the string
  * @returns the repeated string concatenation
@@ -257,6 +291,11 @@ export type CutStringFunction = ((input: string) => string) & ((input: Maybe<str
 /**
  * Creates a {@link CutStringFunction} that truncates strings exceeding the configured maximum length.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilKind factory
+ * @dbxUtilTags string, cut, truncate, ellipsis, max-length, factory, abbreviate
+ *
  * @param config - configuration controlling max length and end text behavior
  * @returns a reusable function that truncates input strings
  */
@@ -264,6 +303,11 @@ export declare function cutStringFunction(config: CutStringFunctionConfig): CutS
 /**
  * Truncates a string to the given maximum length, appending end text (defaults to "...") if truncated.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, cut, truncate, ellipsis, max-length, abbreviate, shorten
+ * @dbxUtilRelated cut-string-function
+ *
  * @param input - the string to truncate, or null/undefined
  * @param maxLength - maximum allowed length for the output string
  * @param endText - text to append when truncated; defaults to "..."
@@ -275,6 +319,11 @@ export declare function cutString(input: Maybe<string>, maxLength: number, endTe
  *
  * Newlines are preserved.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, whitespace, flatten, collapse, normalize, trim
+ * @dbxUtilRelated simplify-whitespace
+ *
  * @param input - string to flatten
  * @returns the string with collapsed whitespace
  */
@@ -282,6 +331,11 @@ export declare function flattenWhitespace(input: string): string;
 /**
  * Reduces multiple consecutive newlines to a single newline and collapses multiple whitespace characters to a single space.
  *
+ * @dbxUtil
+ * @dbxUtilCategory string
+ * @dbxUtilTags string, whitespace, simplify, normalize, newline, trim
+ * @dbxUtilRelated flatten-whitespace
+ *
  * @param input - string to simplify
  * @returns the string with simplified whitespace and newlines
  */

package/src/lib/tree/tree.array.d.ts

@@ -16,6 +16,12 @@ export type ExpandFlattenTreeFunction<T, V> = (values: T[]) => V[];
  * This higher-order function takes a function to expand an array of values `T` into a list of trees (`N[]` where `N` is a TreeNode)
  * and another function to flatten these trees into a single array of values `V`.
  *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilKind factory
+ * @dbxUtilTags tree, expand, flatten, compose, factory, transform
+ * @dbxUtilRelated expand-tree-function, flatten-tree-to-array-function, expand-trees
+ *
  * @template T The type of the initial input values.
  * @template V The type of the values in the final flattened output array.
  * @template N The type of the intermediate tree nodes. Must extend TreeNode with value T and children of type N.

package/src/lib/tree/tree.expand.d.ts

@@ -65,6 +65,11 @@ export declare function expandTreeFunction<T, N extends TreeNode<T, N>>(config:
  * Convenience function for expanding multiple root values into an array of trees.
  * Each value in the input array is treated as a root for a new tree.
  *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilTags tree, expand, multiple, roots, hierarchy, build, batch
+ * @dbxUtilRelated expand-tree-function, expand-flatten-tree-function
+ *
  * @template T The type of the input values.
  * @template N The type of the TreeNode in the resulting trees. Must extend TreeNode<T, N>.
  * @param values An array of root values of type T to expand.

package/src/lib/tree/tree.explore.d.ts

@@ -3,6 +3,12 @@ import { type Maybe } from '../value/maybe.type';
 import { type TreeNode } from './tree';
 /**
  * Decides how to visit a node during tree exploration.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilKind const
+ * @dbxUtilTags tree, explore, visit, decision, enum, traversal, control
+ * @dbxUtilRelated explore-tree-function, flatten-tree-add-node-decision
  */
 export declare const ExploreTreeVisitNodeDecision: {
     /**
@@ -94,6 +100,12 @@ export type ExploreTreeFunction<N extends TreeNode<unknown, N>, V> = (trees: Arr
  * By default uses depth-first traversal, identity mapping, and visits all nodes. All options
  * can be overridden per-call.
  *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilKind factory
+ * @dbxUtilTags tree, explore, traverse, visit, factory, depth-first, breadth-first, walk
+ * @dbxUtilRelated depth-first-explore-tree-traversal-factory-function, breadth-first-explore-tree-traversal-factory-function, flatten-tree-to-array-function
+ *
  * @param config - Optional default configuration for mapping, filtering, and traversal strategy.
  * @returns A reusable function that explores trees with the configured behavior.
  *
@@ -116,6 +128,12 @@ export declare function exploreTreeFunction<N extends TreeNode<unknown, N>, V>(c
  * Visits each node before its children (pre-order). This is the default traversal
  * strategy used by {@link exploreTreeFunction}.
  *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilKind factory
+ * @dbxUtilTags tree, traverse, depth-first, dfs, pre-order, factory, strategy
+ * @dbxUtilRelated breadth-first-explore-tree-traversal-factory-function, explore-tree-function
+ *
  * @returns A traversal factory that processes nodes in depth-first order.
  *
  * @example
@@ -133,6 +151,12 @@ export declare function depthFirstExploreTreeTraversalFactoryFunction<N extends
  * Visits nodes level by level, processing all nodes at depth N before moving to depth N+1.
  * Uses an internal queue to defer child processing until the current level is complete.
  *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilKind factory
+ * @dbxUtilTags tree, traverse, breadth-first, bfs, level-order, factory, strategy, queue
+ * @dbxUtilRelated depth-first-explore-tree-traversal-factory-function, explore-tree-function
+ *
  * @returns A traversal factory that processes nodes in breadth-first order.
  *
  * @example

package/src/lib/tree/tree.flatten.d.ts

@@ -15,6 +15,12 @@ import { type ExploreTreeFunctionConfig, ExploreTreeVisitNodeDecision, type Expl
 export type FlattenTreeFunction<N extends TreeNode<unknown>, V> = (trees: ArrayOrValue<N>, array?: V[], addNodeFn?: Maybe<FlattenTreeAddNodeDecisionFunction<N, V>>) => V[];
 /**
  * Decides how to add a node to the flattened array during flattening.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilKind const
+ * @dbxUtilTags tree, flatten, decision, enum, traversal, control
+ * @dbxUtilRelated explore-tree-visit-node-decision, flatten-tree
  */
 export declare const FlattenTreeAddNodeDecision: {
     /**
@@ -48,6 +54,11 @@ export type FlattenTreeAddNodeDecisionFunction<N extends TreeNode<unknown>, V =
 /**
  * Flattens a tree into an array containing all its nodes using depth-first traversal.
  *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilTags tree, flatten, traverse, depth-first, collect, nodes, array
+ * @dbxUtilRelated flatten-tree-to-array, flatten-tree-to-array-function, explore-tree-function
+ *
  * @param tree - The root node to flatten.
  * @param addNodeFn - Optional filter controlling which nodes and subtrees are included.
  * @returns An array of all nodes in the tree that pass the filter.
@@ -64,6 +75,11 @@ export declare function flattenTree<N extends TreeNode<unknown> = TreeNode<unkno
  *
  * Useful for accumulating nodes from multiple trees into a single collection.
  *
+ * @dbxUtil
+ * @dbxUtilCategory tree
+ * @dbxUtilTags tree, flatten, append, accumulate, collect, mutate, array
+ * @dbxUtilRelated flatten-tree, flatten-tree-to-array-function
+ *
  * @param tree - The root node to flatten.
  * @param array - The target array to push flattened nodes into.
  * @param addNodeFn - Optional filter controlling which nodes and subtrees are included.

package/src/lib/type.d.ts

@@ -17,6 +17,11 @@ export type ObjectWithConstructor = {
  * Returns true if the input is a function-like value with a prototype and constructor (i.e., a class or named function declaration).
  * Returns false for arrow functions, class instances, plain objects, and primitives.
  *
+ * @dbxUtil
+ * @dbxUtilCategory type
+ * @dbxUtilTags type, type-guard, function, class, constructor, reflection
+ * @dbxUtilRelated is-class-like-type, get-function-type, is-non-class-function
+ *
  * @param obj - The value to check.
  * @returns Whether the value is a function with a constructor.
  */
@@ -25,6 +30,11 @@ export declare function isObjectWithConstructor(obj: any): obj is ObjectWithCons
  * Returns true if the input is a class (requires `new` to instantiate). Distinguishes classes from regular functions
  * by checking that the prototype is non-writable.
  *
+ * @dbxUtil
+ * @dbxUtilCategory type
+ * @dbxUtilTags type, type-guard, class, reflection, instance
+ * @dbxUtilRelated is-object-with-constructor, get-function-type
+ *
  * @param obj - The value to check.
  * @returns Whether the value is a class type.
  */
@@ -34,6 +44,11 @@ export type FunctionType = 'function' | 'class' | 'arrow';
  * Determines the function type of the input value: `'class'`, `'function'`, or `'arrow'`.
  * Returns `null` if the input is not a function.
  *
+ * @dbxUtil
+ * @dbxUtilCategory type
+ * @dbxUtilTags type, function, class, arrow, reflection, kind, detect
+ * @dbxUtilRelated is-class-like-type, is-non-class-function, is-object-with-constructor
+ *
  * @param x - The value to inspect.
  * @returns The {@link FunctionType}, or `null` for non-functions.
  */
@@ -41,6 +56,11 @@ export declare function getFunctionType(x: unknown): Maybe<FunctionType>;
 /**
  * Returns true if the input is a function but not a class (i.e., a regular function or arrow function).
  *
+ * @dbxUtil
+ * @dbxUtilCategory type
+ * @dbxUtilTags type, type-guard, function, arrow, reflection, callable
+ * @dbxUtilRelated is-class-like-type, get-function-type
+ *
  * @param x - The value to check.
  * @returns Whether the value is a non-class function.
  */

package/src/lib/value/build.d.ts

@@ -32,6 +32,10 @@ export interface BuildConfig<T extends object> {
  * @param config.build - function that mutates the base object to populate it with desired values
  * @returns the fully constructed object of type T
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags build, builder, construct, mutate, configure, factory
+ *
  * @example
  * ```ts
  * interface User { name: string; age: number; }

package/src/lib/value/comparator.d.ts

@@ -14,6 +14,12 @@ export type EqualityComparatorFunction<T> = (a: T, b: T) => boolean;
  * @param compare - the comparator to wrap
  * @returns a new comparator that handles nullish values safely before delegating to the wrapped comparator
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind factory
+ * @dbxUtilTags equal, equality, compare, comparator, maybe, safe, factory
+ * @dbxUtilRelated safe-compare-equality
+ *
  * @example
  * ```ts
  * const safeCompare = safeEqualityComparatorFunction((a: number, b: number) => a === b);
@@ -34,6 +40,11 @@ export declare function safeEqualityComparatorFunction<T>(compare: EqualityCompa
  * @param compare - the equality comparator for non-nullish values
  * @returns `true` if the values are considered equal
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags equal, equality, compare, maybe, safe
+ * @dbxUtilRelated safe-equality-comparator-function
+ *
  * @example
  * ```ts
  * safeCompareEquality(0, 1, (a, b) => a === b);

package/src/lib/value/decision.d.ts

@@ -21,6 +21,12 @@ export type DecisionFunctionFactory<C, I> = FactoryWithRequiredInput<DecisionFun
  * @param decision - the constant boolean value to return
  * @returns a decision function that always returns the given boolean
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind factory
+ * @dbxUtilTags decision, boolean, predicate, factory, constant
+ * @dbxUtilRelated as-decision-function, invert-decision
+ *
  * @example
  * ```ts
  * const alwaysTrue = decisionFunction(true);
@@ -53,6 +59,11 @@ export declare const invertDecision: <F extends DecisionFunction<any>>(fn: F, in
  * @param defaultIfUndefined - fallback boolean when the input is nullish (defaults to true)
  * @returns a {@link DecisionFunction} derived from the input
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags decision, normalize, boolean, default, coerce, predicate
+ * @dbxUtilRelated decision-function, invert-decision
+ *
  * @example
  * ```ts
  * const fn = asDecisionFunction(true);
@@ -72,6 +83,12 @@ export declare function asDecisionFunction<T = unknown>(valueOrFunction: Maybe<b
  * @param equalityValue - the value to compare against, or an existing decision function
  * @returns a decision function that checks strict equality with the given value
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind factory
+ * @dbxUtilTags decision, equal, equality, factory, predicate, compare
+ * @dbxUtilRelated decision-function, as-decision-function
+ *
  * @example
  * ```ts
  * const isThree = isEqualToValueDecisionFunction(3);

package/src/lib/value/equal.d.ts

@@ -18,6 +18,12 @@ export type AreEqualContext<T = unknown> = (x: IterableOrValue<T>) => boolean;
  * @param fn - the equality comparator
  * @returns a function that checks whether a given value equals the captured reference
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind factory
+ * @dbxUtilTags equal, equality, compare, context, factory
+ * @dbxUtilRelated are-equal-context, all-objects-are-equal
+ *
  * @example
  * ```ts
  * const isEqual = (a: number, b: number) => a === b;
@@ -38,6 +44,12 @@ export declare function isEqualContext<T>(contextValue: T, fn: EqualityComparato
  * @param fn - the equality comparator
  * @returns a function that checks whether all input values equal the captured reference
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind factory
+ * @dbxUtilTags equal, equality, compare, context, iterable, all, factory
+ * @dbxUtilRelated is-equal-context, all-objects-are-equal
+ *
  * @example
  * ```ts
  * const isEqual = (a: number, b: number) => a === b;
@@ -58,6 +70,11 @@ export declare function areEqualContext<T>(contextValue: T, fn: EqualityComparat
  * @param fn - the equality comparator
  * @returns `true` if all values are equal to each other, or if fewer than two values are provided
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags equal, equality, compare, all, iterable, every
+ * @dbxUtilRelated is-equal-context, are-equal-context
+ *
  * @example
  * ```ts
  * const isEqual = (a: unknown, b: unknown) => a === b;

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

@@ -18,6 +18,12 @@ export type ReadValueFunction<I, O> = MapFunction<I, O>;
  * @param mapFunction - function to apply only when the input is defined
  * @returns a new function that short-circuits on null/undefined inputs
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind factory
+ * @dbxUtilTags map, transform, maybe, nullish, factory, optional
+ * @dbxUtilRelated map-array-function, map-identity-function
+ *
  * @example
  * ```ts
  * const double = (x: number) => x * 2;
@@ -52,6 +58,12 @@ export type ApplyMapFunctionWithOptions<I, O, C> = (input: I, target?: Maybe<Par
 /**
  * Lifts a per-element MapFunction into one that operates on arrays, applying the mapping to each element.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind factory
+ * @dbxUtilTags map, transform, array, lift, factory
+ * @dbxUtilRelated map-maybe-function, chain-map-functions
+ *
  * @param mapFunction - per-element transformation
  * @returns a function that maps entire arrays
  */
@@ -62,6 +74,12 @@ export declare function mapArrayFunction<I, O>(mapFunction: MapFunction<I, O>):
  * Used as a sentinel value so that {@link chainMapSameFunctions} and other combinators can detect
  * and skip no-op mappings for efficiency.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind const
+ * @dbxUtilTags map, identity, no-op, sentinel, pass-through, constant
+ * @dbxUtilRelated map-identity-function, is-map-identity-function
+ *
  * @param input - the value to pass through unchanged
  * @returns the same input value, unmodified
  */
@@ -123,6 +141,11 @@ export declare function mapFunctionOutput<O extends object, I = unknown>(output:
  * @param input - one or more optional same-type map functions to chain
  * @returns a single composed function that runs all provided functions in order
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags map, chain, compose, pipeline, identity, transform
+ * @dbxUtilRelated chain-map-function, map-identity-function
+ *
  * @example
  * ```ts
  * const fnChain = chainMapSameFunctions([

package/src/lib/value/maybe.d.ts

@@ -2,6 +2,11 @@ import { type Maybe, type MaybeNot, type MaybeSo } from './maybe.type';
 /**
  * Type guard that returns `true` if the value is not `null` or `undefined`.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, nullish, type-guard, defined, not-null, value
+ * @dbxUtilRelated is-maybe-so, is-maybe-not, has-value-or-not-empty
+ *
  * @param value - the value to check
  * @returns `true` if the value is not `null` or `undefined`
  */
@@ -15,6 +20,11 @@ export declare function hasNonNullValue<T = unknown>(value: Maybe<T>): value is
  *
  * NaN has undefined behavior.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, empty, type-guard, non-empty, value, has-value
+ * @dbxUtilRelated has-value-or-not-empty-object, has-non-null-value, is-not-null-or-empty-string
+ *
  * @param value - the value to check
  * @returns `true` if the value is non-nullish and not empty
  */
@@ -27,6 +37,11 @@ export declare function hasValueOrNotEmpty<T = unknown>(value: Maybe<T>): value
  *
  * NaN has undefined behavior.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, empty, type-guard, object, non-empty, strict
+ * @dbxUtilRelated has-value-or-not-empty, has-non-null-value, object-has-no-keys
+ *
  * @param value - the value to check
  * @returns `true` if the value is non-nullish, non-empty, and not an empty object
  */
@@ -43,6 +58,11 @@ export declare function isStringOrTrue(value: Maybe<string | boolean>): boolean;
  *
  * Useful for filtering out both nullish values and empty strings in a single check.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, string, empty, type-guard, nullish, non-empty
+ * @dbxUtilRelated has-value-or-not-empty, has-non-null-value
+ *
  * @param value - the value to check
  * @returns `true` if the value is not nullish and not an empty string
  */
@@ -50,6 +70,11 @@ export declare function isNotNullOrEmptyString<T>(value: Maybe<MaybeNot | '' | T
 /**
  * Type guard that returns `true` if the input is `null` or `undefined`.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, nullish, type-guard, null, undefined, missing
+ * @dbxUtilRelated is-maybe-so, has-non-null-value
+ *
  * @param value - the value to check
  * @returns `true` if the value is `null` or `undefined`
  */
@@ -59,6 +84,11 @@ export declare function isMaybeNot<T = unknown>(value: Maybe<T>): value is Maybe
  *
  * Equivalent to {@link hasNonNullValue} but with the `MaybeSo` narrowing type.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, nullish, type-guard, defined, present, non-null
+ * @dbxUtilRelated is-maybe-not, has-non-null-value
+ *
  * @param value - the value to check
  * @returns `true` if the value is neither `null` nor `undefined`
  */
@@ -75,6 +105,11 @@ export declare function isMaybeNotOrTrue<T = unknown>(value: Maybe<T | true>): v
 /**
  * Returns `true` if the input is not `null`, `undefined`, or `false`.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, boolean, defined, truthy, type-guard
+ * @dbxUtilRelated is-not-false, has-non-null-value
+ *
  * @param value - the value to check
  * @returns `true` if the value is not `null`, `undefined`, or `false`
  */
@@ -89,6 +124,11 @@ export declare function isNotFalse<T = unknown>(value: Maybe<T>): boolean;
 /**
  * Returns `true` if both inputs are non-nullish and strictly equal (`===`).
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, equal, equality, compare, non-null
+ * @dbxUtilRelated values-are-both-nullish-or-equivalent, has-non-null-value
+ *
  * @param a - first value
  * @param b - second value
  * @returns `true` if both values are non-nullish and strictly equal
@@ -99,6 +139,11 @@ export declare function isSameNonNullValue<T>(a: Maybe<T>, b: Maybe<T>): a is No
  *
  * This means `null` and `undefined` are considered equivalent to each other, but `false` and `null` are not.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, equal, equality, nullish, compare
+ * @dbxUtilRelated is-same-non-null-value
+ *
  * @param a - first value
  * @param b - second value
  * @returns `true` if both are nullish or both are the same value
@@ -111,6 +156,10 @@ export declare function valuesAreBothNullishOrEquivalent<T>(a: Maybe<T>, b: Mayb
  * - If `b` is `null`, returns `null` (explicit clear).
  * - If `b` is defined, returns `b` (new value).
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags maybe, update, merge, sentinel, patch, optional
+ *
  * @param a - the current value
  * @param b - the update value
  * @returns `a` if `b` is undefined, otherwise `b`

package/src/lib/value/modifier.d.ts

@@ -36,6 +36,11 @@ export interface Modifier<T> extends ModifierFunctionRef<T> {
  * @param modify - function that mutates the target value
  * @returns a new {@link Modifier} pairing the key with the modify function
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilTags modifier, mutate, transform, key, factory
+ * @dbxUtilRelated apply-modifiers, modifier-function
+ *
  * @example
  * ```ts
  * const uppercaseName = modifier<{ name: string }>('uppercase', (x) => { x.name = x.name.toUpperCase(); });

package/test/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@dereekb/util/test",
-  "version": "13.10.8",
+  "version": "13.11.0",
   "peerDependencies": {
-    "@dereekb/util": "13.10.8",
+    "@dereekb/util": "13.11.0",
     "make-error": "^1.3.6"
   },
   "exports": {