@augment-vir/common 30.0.0 → 30.0.2

package/dist/augments/string/casing/casing.js

@@ -1,12 +1,33 @@
+/**
+ * Default options for {@link CasingOptions}.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export const defaultCasingOptions = {
     capitalizeFirstLetter: false,
 };
-export var StringCaseEnum;
-(function (StringCaseEnum) {
-    StringCaseEnum["Upper"] = "upper";
-    StringCaseEnum["Lower"] = "lower";
-})(StringCaseEnum || (StringCaseEnum = {}));
-/** Indicates whether the given string has different lower and upper case variants. */
+/**
+ * The different string cases.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export var StringCase;
+(function (StringCase) {
+    StringCase["Upper"] = "upper";
+    StringCase["Lower"] = "lower";
+})(StringCase || (StringCase = {}));
+/**
+ * Indicates whether the given string has different lower and upper case variants. (Some strings
+ * don't, such as all numbers or `'√'`.)
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function hasCase(input) {
     return input.toLowerCase() !== input.toUpperCase();
 }
@@ -16,23 +37,27 @@ export function hasCase(input) {
  * Note that some characters have no casing, such as punctuation (they have no difference between
  * upper and lower casings). By default, those letters always return `true` for this function,
  * regardless of which `caseType` is provided. To instead return `false` for any such characters,
- * pass in an options object and set blockNoCaseCharacters to true.
+ * pass in an options object and set `rejectNoCaseCharacters` to true.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function isCase(input, caseType, options) {
-    if (!input && options?.failOnNoCaseCharacters) {
+    if (!input && options?.rejectNoCaseCharacters) {
         return false;
     }
     for (const letter of input) {
         if (!hasCase(letter)) {
-            if (options?.failOnNoCaseCharacters) {
+            if (options?.rejectNoCaseCharacters) {
                 return false;
             }
             else {
                 continue;
             }
         }
-        else if ((caseType === StringCaseEnum.Upper && letter !== letter.toUpperCase()) ||
-            (caseType === StringCaseEnum.Lower && letter !== letter.toLowerCase())) {
+        else if ((caseType === StringCase.Upper && letter !== letter.toUpperCase()) ||
+            (caseType === StringCase.Lower && letter !== letter.toLowerCase())) {
             return false;
         }
     }

package/dist/augments/string/casing/kebab-and-camel.d.ts

@@ -1,3 +1,17 @@
 import { CasingOptions } from './casing.js';
+/**
+ * Converts a kebab-case string to CamelCase.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function kebabCaseToCamelCase(rawKebabCase: string, casingOptions?: Partial<CasingOptions> | undefined): string;
+/**
+ * Converts a CamelCase string to kebab-case.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export declare function camelCaseToKebabCase(rawCamelCase: string): string;

package/dist/augments/string/casing/kebab-and-camel.js

@@ -1,6 +1,14 @@
+import { mergeDefinedProperties } from '../../object/merge-defined-properties.js';
 import { maybeCapitalize } from './capitalization.js';
-import { defaultCasingOptions, isCase, StringCaseEnum } from './casing.js';
-export function kebabCaseToCamelCase(rawKebabCase, casingOptions = defaultCasingOptions) {
+import { defaultCasingOptions, isCase, StringCase } from './casing.js';
+/**
+ * Converts a kebab-case string to CamelCase.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function kebabCaseToCamelCase(rawKebabCase, casingOptions = {}) {
     const kebabCase = rawKebabCase.toLowerCase();
     if (!kebabCase.length) {
         return '';
@@ -17,16 +25,23 @@ export function kebabCaseToCamelCase(rawKebabCase, casingOptions = defaultCasing
             return '';
         }
     });
-    return maybeCapitalize(camelCase, casingOptions);
+    return maybeCapitalize(camelCase, mergeDefinedProperties(defaultCasingOptions, casingOptions));
 }
+/**
+ * Converts a CamelCase string to kebab-case.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function camelCaseToKebabCase(rawCamelCase) {
     const kebabCase = rawCamelCase
         .split('')
         .reduce((accum, currentLetter, index, originalString) => {
         const previousLetter = index > 0 ? originalString[index - 1] || '' : '';
         const nextLetter = index < originalString.length - 1 ? originalString[index + 1] || '' : '';
-        const possibleWordBoundary = isCase(previousLetter, StringCaseEnum.Lower, { failOnNoCaseCharacters: true }) ||
-            isCase(nextLetter, StringCaseEnum.Lower, { failOnNoCaseCharacters: true });
+        const possibleWordBoundary = isCase(previousLetter, StringCase.Lower, { rejectNoCaseCharacters: true }) ||
+            isCase(nextLetter, StringCase.Lower, { rejectNoCaseCharacters: true });
         if (currentLetter === currentLetter.toLowerCase() ||
             index === 0 ||
             !possibleWordBoundary) {

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

@@ -0,0 +1,26 @@
+/**
+ * Removes all commas from the given string.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function removeCommas(input: string): string;
+/**
+ * Convert the given number into a string, then add commas like a normal number would have.
+ *
+ * @category String
+ * @category Number
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {addCommasToNumber} from '@augment-vir/common';
+ *
+ * addCommasToNumber(1000123.456);
+ * // output is `'1,000,123.456'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function addCommasToNumber(input: number | string): string;

package/dist/augments/string/{commas.js → comma.js}

@@ -1,12 +1,31 @@
-import { safeMatch } from '../regexp/safe-match.js';
+import { safeMatch } from '../regexp/match.js';
 /**
  * Removes all commas from the given string.
  *
- * @category String:Common
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function removeCommas(input) {
     return input.replace(/,/g, '');
 }
+/**
+ * Convert the given number into a string, then add commas like a normal number would have.
+ *
+ * @category String
+ * @category Number
+ * @category Package : @augment-vir/common
+ * @example
+ *
+ * ```ts
+ * import {addCommasToNumber} from '@augment-vir/common';
+ *
+ * addCommasToNumber(1000123.456);
+ * // output is `'1,000,123.456'`
+ * ```
+ *
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
 export function addCommasToNumber(input) {
     if (typeof input === 'string' && isNaN(Number(input))) {
         return 'NaN';

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

@@ -3,8 +3,19 @@
  * item in the list. If the array has a length < 2, the conjunction is not added. If the list is
  * only of length 2, then no commas are added.
  *
- * @param list Array of items to be converted into strings. Works best if these are simply strings
- *   to begin with.
- * @param conjunction Defaults to 'and'. The conjunction to be used before the final element.
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export declare function joinWithFinalConjunction(list: ReadonlyArray<any>, conjunction?: string): string;
+export declare function joinWithFinalConjunction(
+/**
+ * Array of items to be converted into strings. Works best if these are simply strings to begin
+ * with.
+ */
+list: ReadonlyArray<any>, 
+/**
+ * The conjunction to be used before the final element.
+ *
+ * @default 'and'
+ */
+conjunction?: string): string;

package/dist/augments/string/join.js

@@ -3,11 +3,22 @@
  * item in the list. If the array has a length < 2, the conjunction is not added. If the list is
  * only of length 2, then no commas are added.
  *
- * @param list Array of items to be converted into strings. Works best if these are simply strings
- *   to begin with.
- * @param conjunction Defaults to 'and'. The conjunction to be used before the final element.
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export function joinWithFinalConjunction(list, conjunction = 'and') {
+export function joinWithFinalConjunction(
+/**
+ * Array of items to be converted into strings. Works best if these are simply strings to begin
+ * with.
+ */
+list, 
+/**
+ * The conjunction to be used before the final element.
+ *
+ * @default 'and'
+ */
+conjunction = 'and') {
     if (list.length < 2) {
         /**
          * If there are not multiple things in the list to join, just turn the list into a string

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;