@augment-vir/common 30.0.0 → 30.0.1

package/dist/augments/string/prefix.d.ts

@@ -2,12 +2,16 @@
  * Generic string type but with the given prefix prepended to it.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export type WithPrefix<Prefix extends string> = `${Prefix}${string}`;
 /**
  * Adds a prefix to a string if it does not already exist.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function addPrefix<const Prefix extends string>({ value, prefix, }: {
     value: unknown;
@@ -17,6 +21,8 @@ export declare function addPrefix<const Prefix extends string>({ value, prefix,
  * Removes a prefix from a string if it exists.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function removePrefix<const Prefix extends string>({ value, prefix, }: {
     value: string;

package/dist/augments/string/prefix.js

@@ -2,6 +2,8 @@
  * Adds a prefix to a string if it does not already exist.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function addPrefix({ value, prefix, }) {
     if (String(value).startsWith(prefix)) {
@@ -15,6 +17,8 @@ export function addPrefix({ value, prefix, }) {
  * Removes a prefix from a string if it exists.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function removePrefix({ value, prefix, }) {
     if (value.startsWith(prefix)) {

package/dist/augments/string/remove-duplicate-characters.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Removes duplicate characters from any number of strings.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {removeDuplicateCharacters} from '@augment-vir/common';
+ *
+ * removeDuplicateCharacters('aAaBc', 'QrsAa');
+ * // output is `'aABcQrs'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function removeDuplicateCharacters(...values: ReadonlyArray<string>): string;

package/dist/augments/string/remove-duplicate-characters.js

@@ -0,0 +1,22 @@
+import { removeDuplicates } from '../array/remove-duplicates.js';
+/**
+ * Removes duplicate characters from any number of strings.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {removeDuplicateCharacters} from '@augment-vir/common';
+ *
+ * removeDuplicateCharacters('aAaBc', 'QrsAa');
+ * // output is `'aABcQrs'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function removeDuplicateCharacters(...values) {
+    const combined = values.join('');
+    const deDuped = removeDuplicates(Array.from(combined));
+    return Array.from(deDuped).join('');
+}

package/dist/augments/string/replace.d.ts

@@ -1 +1,18 @@
+/**
+ * Replaces whatever substring is at the given index in the original string with the new string.
+ * Optionally, provide a length of the substring to get replaced.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {replaceStringAtIndex} from '@augment-vir/common';
+ *
+ * replaceStringAtIndex('eat the waffles', 4, 'his'); // outputs `'eat his waffles'`
+ * replaceStringAtIndex('eat the waffles', 4, 'my', 3); // outputs `'eat my waffles'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function replaceStringAtIndex(originalString: string, start: number, newString: string, length?: number): string;

package/dist/augments/string/replace.js

@@ -1,3 +1,20 @@
+/**
+ * Replaces whatever substring is at the given index in the original string with the new string.
+ * Optionally, provide a length of the substring to get replaced.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {replaceStringAtIndex} from '@augment-vir/common';
+ *
+ * replaceStringAtIndex('eat the waffles', 4, 'his'); // outputs `'eat his waffles'`
+ * replaceStringAtIndex('eat the waffles', 4, 'my', 3); // outputs `'eat my waffles'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function replaceStringAtIndex(originalString, start, newString, length = newString.length) {
     const before = originalString.slice(0, Math.max(0, start));
     const after = originalString.slice(Math.max(0, start + length));

package/dist/augments/string/split.d.ts

@@ -1,4 +1,31 @@
 import type { AtLeastTuple } from '@augment-vir/core';
-/** Same as String.prototype.split but includes the delimiter to split by in the output array. */
-export declare function splitIncludeSplit(original: string, splitterInput: string | RegExp, caseSensitive: boolean): readonly string[];
+/**
+ * Same as *
+ * [`''.split`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/split)
+ * but includes the split delimiter in the output array.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {splitIncludeSplit} from '@augment-vir/common';
+ *
+ * splitIncludeSplit('1,2,3', ',', {caseSensitive: false}); // outputs `['1', ',', '2', ',', '3']`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function splitIncludeSplit(original: string, splitDelimiter: string | RegExp, { caseSensitive }: {
+    caseSensitive: boolean;
+}): readonly string[];
+/**
+ * Same as
+ * [`''.split`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/split)
+ * but typed better: it always returns an array with at least one string.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function safeSplit(input: string, splitString: string): AtLeastTuple<string, 1>;

package/dist/augments/string/split.js

@@ -1,14 +1,30 @@
-import { makeCaseInsensitiveRegExp } from '../regexp/regexp-flags.js';
-import { getSubstringIndexes } from './substring-index.js';
-/** Same as String.prototype.split but includes the delimiter to split by in the output array. */
-export function splitIncludeSplit(original, splitterInput, caseSensitive) {
-    const indexLengths = getSubstringIndexes({
+import { setRegExpCaseSensitivity } from '../regexp/regexp-flags.js';
+import { findSubstringIndexes } from './substring-index.js';
+/**
+ * Same as *
+ * [`''.split`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/split)
+ * but includes the split delimiter in the output array.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {splitIncludeSplit} from '@augment-vir/common';
+ *
+ * splitIncludeSplit('1,2,3', ',', {caseSensitive: false}); // outputs `['1', ',', '2', ',', '3']`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function splitIncludeSplit(original, splitDelimiter, { caseSensitive }) {
+    const indexLengths = findSubstringIndexes({
         searchIn: original,
-        searchFor: splitterInput,
+        searchFor: splitDelimiter,
         caseSensitive,
         includeLength: true,
     });
-    const splitter = makeCaseInsensitiveRegExp(splitterInput, caseSensitive);
+    const splitter = setRegExpCaseSensitivity(splitDelimiter, { caseSensitive });
     const splits = original.split(splitter);
     return splits.reduce((accum, current, index) => {
         // this will be undefined on the last index
@@ -23,6 +39,15 @@ export function splitIncludeSplit(original, splitterInput, caseSensitive) {
         }
     }, []);
 }
+/**
+ * Same as
+ * [`''.split`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/split)
+ * but typed better: it always returns an array with at least one string.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function safeSplit(input, splitString) {
     return input.split(splitString);
 }

package/dist/augments/string/substring-index.d.ts

@@ -1,11 +1,17 @@
-export declare function getSubstringIndexes<IncludeLength extends boolean | undefined>({ searchIn, searchFor, caseSensitive, includeLength, }: {
+/**
+ * Finds all indexes of a `searchFor` string or RegExp in `searchIn`. Ths is similar to
+ * [`''.indexOf`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf)
+ * except that it finds _all_ indexes of.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function findSubstringIndexes<IncludeLength extends boolean | undefined>({ searchIn, searchFor, caseSensitive, includeLength, }: {
     searchIn: string;
     searchFor: string | RegExp;
-    /**
-     * CaseSensitive only applies when the input is a string. Otherwise, the RegExp's "i" flag is
-     * used to determine case sensitivity.
-     */
     caseSensitive: boolean;
+    /** Set to true to get an array of objects with the found indexes _and_ their lengths. */
     includeLength?: IncludeLength;
 }): IncludeLength extends true ? {
     index: number;

package/dist/augments/string/substring-index.js

@@ -1,6 +1,15 @@
-import { makeCaseInsensitiveRegExp } from '../regexp/regexp-flags.js';
-export function getSubstringIndexes({ searchIn, searchFor, caseSensitive, includeLength, }) {
-    const searchRegExp = makeCaseInsensitiveRegExp(searchFor, caseSensitive);
+import { addRegExpFlags, setRegExpCaseSensitivity } from '../regexp/regexp-flags.js';
+/**
+ * Finds all indexes of a `searchFor` string or RegExp in `searchIn`. Ths is similar to
+ * [`''.indexOf`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf)
+ * except that it finds _all_ indexes of.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function findSubstringIndexes({ searchIn, searchFor, caseSensitive, includeLength, }) {
+    const searchRegExp = addRegExpFlags(setRegExpCaseSensitivity(searchFor, { caseSensitive }), 'g');
     const indexes = [];
     const indexesAndLengths = [];
     searchIn.replace(searchRegExp, (...matchResults) => {

package/dist/augments/string/suffix.d.ts

@@ -2,62 +2,82 @@
  * Generic string type but with the given suffix appended to it.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export type WithSuffix<Suffix extends string> = `${string}${Suffix}`;
 /**
  * Suffix for {@link addPercent} and {@link removePercent}.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare const percentSuffix = "%";
 /**
  * Suffix for {@link addPx} and {@link removePx}.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare const pxSuffix = "px";
 /**
  * Generic string type but with the `'px'` suffix appended to it.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export type WithPx = WithSuffix<typeof pxSuffix>;
 /**
  * Generic string type but with the `'%'` suffix appended to it.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export type WithPercent = WithSuffix<typeof percentSuffix>;
 /**
  * Adds the `'px'` suffix to a string if it does not already exist.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function addPx(input: number | string): WithPx;
 /**
  * Removes the `'px'` suffix from a string if it exists.
  *
  * @category String
+ * @category Package : @augment-vir/common
  * @throws `TypeError` if the input can't be converted into a number.
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function removePx(input: string): number;
 /**
  * Adds the `'%'` suffix to a string if it does not already exist.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function addPercent(input: number | string): WithPercent;
 /**
  * Removes the `'%'` suffix from a string if it exists.
  *
  * @category String
+ * @category Package : @augment-vir/common
  * @throws `TypeError` if the input can't be converted into a number.
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function removePercent(input: string): number;
 /**
  * Adds a suffix to a string if it does not already exist.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function addSuffix<const Suffix extends string>({ value, suffix, }: {
     value: unknown;
@@ -67,6 +87,8 @@ export declare function addSuffix<const Suffix extends string>({ value, suffix,
  * Removes a suffix from a string if it exists.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function removeSuffix<const Suffix extends string>({ value, suffix, }: {
     value: string;

package/dist/augments/string/suffix.js

@@ -3,18 +3,24 @@ import { toEnsuredNumber } from '../number/number-conversion.js';
  * Suffix for {@link addPercent} and {@link removePercent}.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export const percentSuffix = '%';
 /**
  * Suffix for {@link addPx} and {@link removePx}.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export const pxSuffix = 'px';
 /**
  * Adds the `'px'` suffix to a string if it does not already exist.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function addPx(input) {
     return addSuffix({ value: input, suffix: pxSuffix });
@@ -23,7 +29,9 @@ export function addPx(input) {
  * Removes the `'px'` suffix from a string if it exists.
  *
  * @category String
+ * @category Package : @augment-vir/common
  * @throws `TypeError` if the input can't be converted into a number.
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function removePx(input) {
     return toEnsuredNumber(removeSuffix({ value: input, suffix: pxSuffix }));
@@ -32,6 +40,8 @@ export function removePx(input) {
  * Adds the `'%'` suffix to a string if it does not already exist.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function addPercent(input) {
     return addSuffix({ value: input, suffix: percentSuffix });
@@ -40,7 +50,9 @@ export function addPercent(input) {
  * Removes the `'%'` suffix from a string if it exists.
  *
  * @category String
+ * @category Package : @augment-vir/common
  * @throws `TypeError` if the input can't be converted into a number.
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function removePercent(input) {
     return toEnsuredNumber(removeSuffix({ value: input, suffix: percentSuffix }));
@@ -49,6 +61,8 @@ export function removePercent(input) {
  * Adds a suffix to a string if it does not already exist.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function addSuffix({ value, suffix, }) {
     if (String(value).endsWith(suffix)) {
@@ -62,6 +76,8 @@ export function addSuffix({ value, suffix, }) {
  * Removes a suffix from a string if it exists.
  *
  * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function removeSuffix({ value, suffix, }) {
     if (value.endsWith(suffix)) {

package/dist/augments/string/white-space.d.ts

@@ -1,5 +1,12 @@
 import { PartialWithUndefined } from '@augment-vir/core';
-/** Collapse all consecutive white space into just one space and trim surrounding whitespace. */
+/**
+ * Collapse all consecutive white space into just one space and trim surrounding whitespace.
+ * Optionally, collapsed newlines can be preserved.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function collapseWhiteSpace(input: string, { keepNewLines }?: PartialWithUndefined<{
     keepNewLines: boolean;
 }>): string;

package/dist/augments/string/white-space.js

@@ -1,4 +1,11 @@
-/** Collapse all consecutive white space into just one space and trim surrounding whitespace. */
+/**
+ * Collapse all consecutive white space into just one space and trim surrounding whitespace.
+ * Optionally, collapsed newlines can be preserved.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function collapseWhiteSpace(input, { keepNewLines } = {}) {
     if (keepNewLines) {
         return input

package/dist/augments/string/wrap-string.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Wraps a string in another string.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {wrapString} from '@augment-vir/common';
+ *
+ * wrapString({value: 'some words', wrapper: '"'}); // outputs `'"some words"'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function wrapString({ value, wrapper }: {
     value: string;
     wrapper: string;

package/dist/augments/string/wrap-string.js

@@ -1,5 +1,20 @@
 import { addPrefix } from './prefix.js';
 import { addSuffix } from './suffix.js';
+/**
+ * Wraps a string in another string.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {wrapString} from '@augment-vir/common';
+ *
+ * wrapString({value: 'some words', wrapper: '"'}); // outputs `'"some words"'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function wrapString({ value, wrapper }) {
     return addPrefix({ value: addSuffix({ value, suffix: wrapper }), prefix: wrapper });
 }

package/dist/augments/type/ensure-type.d.ts

@@ -4,5 +4,9 @@
  * the generic being inferred from the inputs), there will actually be a type error. This forces
  * each usage of this function to explicitly specify the generic, thus giving us type safety for the
  * input.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare function ensureType<ExpectedType = never>(input: NoInfer<ExpectedType>): NoInfer<ExpectedType>;

package/dist/augments/type/ensure-type.js

@@ -4,6 +4,10 @@
  * the generic being inferred from the inputs), there will actually be a type error. This forces
  * each usage of this function to explicitly specify the generic, thus giving us type safety for the
  * input.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function ensureType(input) {
     return input;

package/dist/augments/type/readonly.d.ts

@@ -1,2 +1,9 @@
 export type { ReadonlyDeep } from 'type-fest';
+/**
+ * This function does nothing but return the input as a readonly typed version of itself.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function makeReadonly<T>(input: T): Readonly<T>;

package/dist/augments/type/readonly.js

@@ -1,3 +1,10 @@
+/**
+ * This function does nothing but return the input as a readonly typed version of itself.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function makeReadonly(input) {
     return input;
 }

package/dist/augments/type/type-recursion.d.ts

@@ -150,12 +150,104 @@ type TsRecursionArray = [
     149,
     150
 ];
+/**
+ * This is used as the baseline type for TypeScript recursion tracking indexes. Use this to manually
+ * abort a type's recursion to prevent it from going too deep and throwing an error in TypeScript's
+ * language server.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import type {
+ *     TsRecursionTracker,
+ *     TsRecursionStart,
+ *     TsRecurse,
+ *     TsTooMuchRecursion,
+ * } from '@augment-vir/common';
+ *
+ * export type SomeType<Depth extends TsRecursionTracker = TsRecursionStart> =
+ *     Depth extends TsTooMuchRecursion
+ *         ? 'Error: recursive object depth is too deep.'
+ *         : SomeType<TsRecurse<Depth>>;
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export type TsRecursionTracker = keyof TsRecursionArray;
 /**
  * Through experimentation on Typescript version 5.4.5, this is the maximum recursion depth we can
- * go to before TypeScript will block recursive types.
+ * go to before TypeScript will block recursive types. Use this as the limit to type recursion.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import type {
+ *     TsRecursionTracker,
+ *     TsRecursionStart,
+ *     TsRecurse,
+ *     TsTooMuchRecursion,
+ * } from '@augment-vir/common';
+ *
+ * export type SomeType<Depth extends TsRecursionTracker = TsRecursionStart> =
+ *     Depth extends TsTooMuchRecursion
+ *         ? 'Error: recursive object depth is too deep.'
+ *         : SomeType<TsRecurse<Depth>>;
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export type TsTooMuchRecursion = 91;
+/**
+ * This is the default starting recursion depth needed to get the full tested allowed recursion
+ * depth.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import type {
+ *     TsRecursionTracker,
+ *     TsRecursionStart,
+ *     TsRecurse,
+ *     TsTooMuchRecursion,
+ * } from '@augment-vir/common';
+ *
+ * export type SomeType<Depth extends TsRecursionTracker = TsRecursionStart> =
+ *     Depth extends TsTooMuchRecursion
+ *         ? 'Error: recursive object depth is too deep.'
+ *         : SomeType<TsRecurse<Depth>>;
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export type TsRecursionStart = 0;
+/**
+ * Increments a TypeScript recursion depth tracker.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import type {
+ *     TsRecursionTracker,
+ *     TsRecursionStart,
+ *     TsRecurse,
+ *     TsTooMuchRecursion,
+ * } from '@augment-vir/common';
+ *
+ * export type SomeType<Depth extends TsRecursionTracker = TsRecursionStart> =
+ *     Depth extends TsTooMuchRecursion
+ *         ? 'Error: recursive object depth is too deep.'
+ *         : SomeType<TsRecurse<Depth>>;
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export type TsRecurse<CurrentRecursion extends TsRecursionTracker> = TsRecursionArray[CurrentRecursion] extends TsRecursionTracker ? TsRecursionArray[CurrentRecursion] : TsTooMuchRecursion;
 export {};

package/dist/augments/type/union.d.ts

@@ -0,0 +1 @@
+export type { UnionToIntersection } from 'type-fest';

package/dist/augments/type/union.js

@@ -0,0 +1 @@
+export {};

package/dist/augments/type/void-type.d.ts

@@ -1,5 +1,9 @@
 /**
- * Require that the NonVoid parameter is not void. If it is void, the ErrorType or an error string
- * type is returned. If it not void, the given SuccessType is returned.
+ * Require that the given `NonVoid` parameter is not void. If it is void, the `ErrorType` or an
+ * error string type is returned. If it not void, the given `SuccessType` is returned.
+ *
+ * @category Type
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export type RequireNonVoid<NonVoid, SuccessType, ErrorType = 'Input should not be void'> = void extends NonVoid ? (NonVoid extends void ? ErrorType : SuccessType) : SuccessType;