@tolki/str 1.0.0 → 1.0.2

package/dist/str.d.ts

@@ -6,10 +6,6 @@
  * @returns The portion of the string after the last occurrence of the search value
  *
  * @see https://tolki.abe.dev/strings/string-utilities-list.html#after
- *
- * @example
- *
- * after('A house on a lake', 'house '); -> 'on a lake'
  */
 export declare function after(subject: string, search: string | number): string;
 /**
@@ -28,6 +24,8 @@ export declare function afterLast(subject: string, search: string | number): str
  * @param subject - The string to search in
  * @param search - The value to search for
  * @returns The portion of the string before the first occurrence of the search value
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#before
  */
 export declare function before(subject: string, search: string | number): string;
 /**
@@ -37,9 +35,7 @@ export declare function before(subject: string, search: string | number): string
  * @param search - The value to search for
  * @returns The portion of the string before the last occurrence of the search value
  *
- * @example
- *
- * beforeLast('yvette', 'tte'); -> 'yve'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#beforelast
  */
 export declare function beforeLast(subject: string, search: string | number): string;
 /**
@@ -50,9 +46,7 @@ export declare function beforeLast(subject: string, search: string | number): st
  * @param to - The ending value
  * @returns The portion of the string between the two given values
  *
- * @example
- *
- * between('foofoobar', 'foo', 'bar'); -> 'foo'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#between
  */
 export declare function between(subject: string, from: string | number, to: string | number): string;
 /**
@@ -63,9 +57,7 @@ export declare function between(subject: string, from: string | number, to: stri
  * @param to - The ending value
  * @returns The smallest portion of the string between the two given values
  *
- * @example
- *
- * betweenFirst('foofoobar', 'foo', 'bar'); -> 'foo'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#betweenfirst
  */
 export declare function betweenFirst(subject: string, from: string | number, to: string | number): string;
 /**
@@ -74,9 +66,7 @@ export declare function betweenFirst(subject: string, from: string | number, to:
  * @param value - The string to convert
  * @returns The camel-cased string
  *
- * @example
- *
- * camel('foo_bar'); -> 'fooBar'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#camel
  */
 export declare function camel(value: string): string;
 /**
@@ -86,9 +76,7 @@ export declare function camel(value: string): string;
  * @param index - The index of the character to get
  * @returns The character at the specified index, or false if the index is out of bounds
  *
- * @example
- *
- * charAt('hello', 1); -> 'e'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#charat
  */
 export declare function charAt(subject: string, index: number): string | false;
 /**
@@ -98,9 +86,7 @@ export declare function charAt(subject: string, index: number): string | false;
  * @param needle - The string or strings to remove
  * @returns The string with the given string(s) removed from the start
  *
- * @example
- *
- * chopStart('foobar', 'foo'); -> 'bar'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#chopstart
  */
 export declare function chopStart(subject: string, needle: string | string[]): string;
 /**
@@ -110,9 +96,7 @@ export declare function chopStart(subject: string, needle: string | string[]): s
  * @param needle - The string or strings to remove
  * @returns The string with the given string(s) removed from the end
  *
- * @example
- *
- * chopEnd('foobar', 'bar'); -> 'foo'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#chopend
  */
 export declare function chopEnd(subject: string, needle: string | string[]): string;
 /**
@@ -122,11 +106,7 @@ export declare function chopEnd(subject: string, needle: string | string[]): str
  * @param needles - The substring or substrings to search for
  * @param ignoreCase - Whether to ignore case when searching
  *
- * @example
- *
- * contains('Minion', 'ni'); -> true
- * contains('Minion', 'Ni', true); -> true
- * contains('Minion', 'Ni', false); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#contains
  */
 export declare function contains(haystack: string, needles: string | Iterable<string>, ignoreCase?: boolean): boolean;
 /**
@@ -137,8 +117,7 @@ export declare function contains(haystack: string, needles: string | Iterable<st
  * @param options - Additional options for excerpt extraction
  * @returns The extracted excerpt, or null if the phrase is not found
  *
- * @example
- * excerpt('The quick brown fox', 'brown', { radius: 5 });
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#excerpt
  */
 export declare function excerpt(text: string | null, phrase?: string | null, options?: {
     radius?: number;
@@ -152,10 +131,7 @@ export declare function excerpt(text: string | null, phrase?: string | null, opt
  * @param ignoreCase - Whether to ignore case when searching
  * @returns True if all substrings are found, false otherwise
  *
- * @example
- *
- * containsAll('Taylor Otwell', ['taylor', 'otwell'], false); -> true
- * containsAll('Taylor Otwell', ['taylor', 'xxx'], true); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#containsall
  */
 export declare function containsAll(haystack: string, needles: Iterable<string>, ignoreCase?: boolean): boolean;
 /**
@@ -166,11 +142,7 @@ export declare function containsAll(haystack: string, needles: Iterable<string>,
  * @param ignoreCase - Whether to ignore case when searching
  * @returns True if the substring is not found, false otherwise
  *
- * @example
- *
- * doesntContain('Minion', 'ni'); -> false
- * doesntContain('Minion', 'Ni', true); -> false
- * doesntContain('Minion', 'Ni', false); -> true
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#doesntcontain
  */
 export declare function doesntContain(haystack: string, needles: string | Iterable<string>, ignoreCase?: boolean): boolean;
 /**
@@ -180,12 +152,7 @@ export declare function doesntContain(haystack: string, needles: string | Iterab
  * @param character - The character or characters to deduplicate
  * @returns The string with consecutive instances of the character(s) replaced by a single instance
  *
- * @example
- *
- * deduplicate('hello  world'); -> 'hello world'
- * deduplicate('hello---world', '-'); -> 'hello-world'
- * deduplicate('hello___world', '_'); -> 'hello-world'
- * deduplicate('hello  world', ' '); -> 'hello world'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#deduplicate
  */
 export declare function deduplicate(value: string, character?: string | string[]): string;
 /**
@@ -195,10 +162,7 @@ export declare function deduplicate(value: string, character?: string | string[]
  * @param needles - The substring or substrings to search for
  * @returns True if the string ends with any of the substrings, false otherwise
  *
- * @example
- *
- * endsWith("Jason", "on"); -> true
- * endsWith("Jason", "ON"); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#endswith
  */
 export declare function endsWith(haystack: string | number | null, needles: string | number | Iterable<string>): boolean;
 /**
@@ -208,10 +172,7 @@ export declare function endsWith(haystack: string | number | null, needles: stri
  * @param needles - The substring or substrings to search for
  * @returns True if the string does not end with any of the substrings, false otherwise
  *
- * @example
- *
- * doesntEndWith("Jason", "on"); -> false
- * doesntEndWith("Jason", "ON"); -> true
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#doesntendwith
  */
 export declare function doesntEndWith(haystack: string | number | null, needles: string | number | Iterable<string>): boolean;
 /**
@@ -221,9 +182,7 @@ export declare function doesntEndWith(haystack: string | number | null, needles:
  * @param cap - The string to cap with
  * @returns The capped string
  *
- * @example
- *
- * finish('hello', '!'); -> 'hello!'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#finish
  */
 export declare function finish(value: string, cap: string): string;
 /**
@@ -234,9 +193,7 @@ export declare function finish(value: string, cap: string): string;
  * @param after - The string to append (if null, use the 'before' string)
  * @returns The wrapped string
  *
- * @example
- *
- * wrap('hello', '[', ']'); -> '[hello]'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#wrap
  */
 export declare function wrap(value: string, before: string, after?: string | null): string;
 /**
@@ -247,9 +204,7 @@ export declare function wrap(value: string, before: string, after?: string | nul
  * @param after - The string to remove from the end (if null, use the 'before' string)
  * @returns The unwrapped string
  *
- * @example
- *
- * unwrap('[hello]', '[', ']'); -> 'hello'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#unwrap
  */
 export declare function unwrap(value: string, before: string, after?: string | null): string;
 /**
@@ -260,11 +215,7 @@ export declare function unwrap(value: string, before: string, after?: string | n
  * @param ignoreCase - Whether to ignore case when matching
  * @return True if the string matches the pattern, false otherwise
  *
- * @example
- *
- * is('hello', 'hello'); -> true
- * is('hello', 'Hello', true); -> true
- * is('hello', 'world'); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#is
  */
 export declare function is(pattern: string | Iterable<string>, value: string | number, ignoreCase?: boolean): boolean;
 /**
@@ -273,13 +224,7 @@ export declare function is(pattern: string | Iterable<string>, value: string | n
  * @param value - The string to check
  * @returns True if the string is ASCII, false otherwise
  *
- * @example
- *
- * isAscii("Hello World"); -> true
- * isAscii("こんにちは"); -> false
- * isAscii("12345"); -> true
- * isAscii("!@#$%"); -> true
- * isAscii("Hello こんにちは"); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#isascii
  */
 export declare function isAscii(value: string): boolean;
 /**
@@ -288,11 +233,7 @@ export declare function isAscii(value: string): boolean;
  * @param value - The value to check if it's JSON
  * @returns True if the value is valid JSON, false otherwise
  *
- * @example
- *
- * isJson('{"name": "John", "age": 30}'); -> true
- * isJson('{"name": "John", "age": 30'); -> false
- * isJson('Hello World'); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#isjson
  */
 export declare function isJson(value: unknown): boolean;
 /**
@@ -302,11 +243,7 @@ export declare function isJson(value: unknown): boolean;
  * @param protocols - An optional array of allowed protocols (e.g., ['http', 'https'])
  * @return True if the value is a valid URL, false otherwise
  *
- * @example
- *
- * isUrl('https://laravel.com'); -> true
- * isUrl('http://localhost'); -> true
- * isUrl('invalid url'); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#isurl
  */
 export declare function isUrl(value: string | unknown, protocols?: string[]): boolean;
 /**
@@ -315,9 +252,7 @@ export declare function isUrl(value: string | unknown, protocols?: string[]): bo
  * @param value - The string to convert
  * @returns The kebab-cased string
  *
- * @example
- *
- * kebab("Laravel PHP Framework"); -> "laravel-php-framework"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#kebab
  */
 export declare function kebab(value: string): string;
 /**
@@ -326,9 +261,7 @@ export declare function kebab(value: string): string;
  * @param value - The string to measure
  * @returns The length of the string
  *
- * @example
- *
- * length("Hello World"); -> 11
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#length
  */
 export declare function length(value: string): number;
 /**
@@ -339,6 +272,8 @@ export declare function length(value: string): number;
  * @param end - The string to append if the value is truncated
  * @param preserveWords - Whether to preserve whole words when truncating
  * @returns The limited string
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#limit
  */
 export declare function limit(value: string, limit?: number, end?: string, preserveWords?: boolean): string;
 /**
@@ -347,9 +282,7 @@ export declare function limit(value: string, limit?: number, end?: string, prese
  * @param value - The string to convert
  * @returns The lower-cased string
  *
- * @example
- *
- * lower("Hello World"); -> "hello world"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#lower
  */
 export declare function lower(value: string): string;
 /**
@@ -360,10 +293,7 @@ export declare function lower(value: string): string;
  * @param end - The string to append if the value is truncated
  * @returns The limited string
  *
- * @example
- *
- * words("Laravel PHP Framework", 2); -> "Laravel PHP Framework"
- * words("Laravel PHP Framework", 1); -> "Laravel..."
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#words
  */
 export declare function words(value: string, words?: number, end?: string): string;
 /**
@@ -375,12 +305,7 @@ export declare function words(value: string, words?: number, end?: string): stri
  * @param length - The number of characters to mask (if null, mask to the end of the string)
  * @returns The masked string
  *
- * @example
- *
- * mask("taylor@email.com", "*", 3); -> "tay*************"
- * mask("taylor@email.com", "*", 0, 6); -> "******@email.com"
- * mask("taylor@email.com", "*", -13); -> "tay*************"
- * mask("taylor@email.com", "*", -13, 3); -> "tay***@email.com"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#mask
  */
 export declare function mask(value: string, character: string, index: number, length?: number | null): string;
 /**
@@ -389,6 +314,8 @@ export declare function mask(value: string, character: string, index: number, le
  * @param pattern - The regex pattern to match
  * @param subject - The string to search within
  * @returns The matched string or an empty string if no match
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#match
  */
 export declare function match(pattern: string, subject: string): string;
 /**
@@ -398,22 +325,17 @@ export declare function match(pattern: string, subject: string): string;
  * @param value - The string to check
  * @return True if the string matches the pattern, false otherwise
  *
- * @example
- *
- * Str::isMatch('/foo/', 'foo bar'); // true
- * Str::isMatch('/bar/', 'foo bar'); // false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#ismatch
  */
 export declare function isMatch(pattern: string | Iterable<string>, value: string): boolean;
 /**
- * Get the string matching the given pattern.
+ * Get the string(s) matching the given pattern.
  *
  * @param pattern - The regex pattern to match
  * @param subject - The string to search within
  * @returns An array of all matched strings
  *
- * @example
- *
- * matchAll("/foo (.*)/", "foo bar baz"); -> ["foo bar baz"]
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#matchall
  */
 export declare function matchAll(pattern: string, subject: string): string[];
 /**
@@ -422,51 +344,40 @@ export declare function matchAll(pattern: string, subject: string): string[];
  * @param value - The string or array of strings to process
  * @returns The numeric-only string or array of strings
  *
- * @example
- *
- * numbers("foo123bar"); -> "123"
- * numbers(["foo123bar", "abc456"]); -> ["123", "456"]
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#numbers
  */
 export declare function numbers(value: string | string[]): string | string[];
 /**
- * Pad both sides of a string with another.
+ * Pad both sides of a string with another string to a certain length.
  *
  * @param value - The string to pad
  * @param length - The desired total length after padding
  * @param pad - The string to use for padding
  * @returns The padded string
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#padboth
  */
 export declare function padBoth(value: string, length: number, pad?: string): string;
 /**
- * Pad the left side of a string with another.
+ * Pad the left side of a string with another string to a certain length.
  *
  * @param value - The string to pad
  * @param length - The desired total length after padding
  * @param pad - The string to use for padding
  * @returns The padded string
  *
- * @example
- *
- * padLeft("Alien", 10, "-="); -> "-=-=-Alien"
- * padLeft("Alien", 10); -> "     Alien"
- * padLeft("❤MultiByte☆", 16); -> "     ❤MultiByte☆"
- * padLeft("❤MultiByte☆", 16, "❤☆"); -> "❤☆❤☆❤❤MultiByte☆"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#padleft
  */
 export declare function padLeft(value: string, length: number, pad?: string): string;
 /**
- * Pad the right side of a string with another.
+ * Pad the right side of a string with another string to a certain length.
  *
  * @param value - The string to pad
  * @param length - The desired total length after padding
  * @param pad - The string to use for padding
  * @returns The padded string
  *
- * @example
- *
- * padRight("Alien", 10, "-="); -> "Alien-=-="
- * padRight("Alien", 10); -> "Alien     "
- * padRight("❤MultiByte☆", 16); -> "❤MultiByte☆     "
- * padRight("❤MultiByte☆", 16, "❤☆"); -> "❤MultiByte☆❤☆❤☆"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#padright
  */
 export declare function padRight(value: string, length: number, pad?: string): string;
 /**
@@ -497,6 +408,8 @@ export declare function makePad(padStr: string, needed: number): string;
  * @param symbols Whether to include symbols (default: true)
  * @param spaces Whether to include spaces (default: false)
  * @return The generated password string
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#password
  */
 export declare function password(length?: number, letters?: boolean, numbers?: boolean, symbols?: boolean, spaces?: boolean): string;
 /**
@@ -507,10 +420,7 @@ export declare function password(length?: number, letters?: boolean, numbers?: b
  * @param offset - The position to start searching from (can be negative)
  * @returns The position of the first occurrence or false if not found
  *
- * @example
- *
- * position('Hello, World!', 'World!'); -> 7
- * position('Hello, World!', 'world!', 0); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#position
  */
 export declare function position(haystack: string, needle: string, offset?: number): number | false;
 /**
@@ -519,9 +429,7 @@ export declare function position(haystack: string, needle: string, offset?: numb
  * @param length - The desired length of the random string (default: 16)
  * @returns The generated random string
  *
- * @example
- *
- * random(); -> "a1b2c3d4e5f6g7h8"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#random
  */
 export declare function random(length?: number): string;
 /**
@@ -530,9 +438,7 @@ export declare function random(length?: number): string;
  * @param factory - The factory function to generate random strings
  * @returns void
  *
- * @example
- *
- * createRandomStringsUsing((length) => "x".repeat(length));
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#random
  */
 export declare function createRandomStringsUsing(factory: ((length: number) => string) | null): void;
 /**
@@ -553,9 +459,7 @@ export declare function createRandomStringsUsingSequence(sequence: string[], whe
  *
  * @returns void
  *
- * @example
- *
- * createRandomStringsNormally();
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#random
  */
 export declare function createRandomStringsNormally(): void;
 /**
@@ -565,9 +469,7 @@ export declare function createRandomStringsNormally(): void;
  * @param times - The number of times to repeat the string
  * @returns The repeated string
  *
- * @example
- *
- * repeat("foo", 3); -> "foofoofoo"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#repeat
  */
 export declare function repeat(string: string, times: number): string;
 /**
@@ -578,11 +480,7 @@ export declare function repeat(string: string, times: number): string;
  * @param subject - The string to perform replacements on
  * @returns The resulting string after replacements
  *
- * @example
- *
- * replaceArray('?', ['foo', 'bar', 'baz'], '?/?/?'); -> 'foo/bar/baz'
- * replaceArray('?', ['foo', 'bar', 'baz'], '?/?/?/?'); -> 'foo/bar/baz/?'
- * replaceArray('?', {'x' => 'foo', 'y' => 'bar'}, '?/?'); -> 'foo/bar'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#replacearray
  */
 export declare function replaceArray(search: string, replace: Record<string, string> | Iterable<string>, subject: string): string;
 /**
@@ -606,9 +504,7 @@ export declare function toStringOr(value: unknown, fallback: string): string;
  * @param caseSensitive - Whether the search should be case-sensitive (default: true)
  * @returns The resulting string or array of strings after replacements
  *
- * @example
- *
- * replace("foo", "bar", "foo baz"); -> "bar baz"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#replace
  */
 export declare function replace<T extends string | Iterable<string>>(search: string | Iterable<string>, replacement: string | Iterable<string>, subject: T, caseSensitive?: boolean): T extends string ? string : string[];
 /**
@@ -619,9 +515,7 @@ export declare function replace<T extends string | Iterable<string>>(search: str
  * @param subject - The string to perform the replacement on
  * @returns The resulting string after replacement
  *
- * @example
- *
- * replaceFirst('bar', 'qux', 'foobar foobar'); -> 'fooqux foobar'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#replacefirst
  */
 export declare function replaceFirst(search: string | number, replace: string, subject: string): string;
 /**
@@ -631,6 +525,8 @@ export declare function replaceFirst(search: string | number, replace: string, s
  * @param replace - The value to replace with
  * @param subject - The string to perform the replacement on
  * @returns The resulting string after replacement
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#replacestart
  */
 export declare function replaceStart(search: string | number, replace: string, subject: string): string;
 /**
@@ -641,9 +537,7 @@ export declare function replaceStart(search: string | number, replace: string, s
  * @param subject - The string to perform the replacement on
  * @returns The resulting string after replacement
  *
- * @example
- *
- * replaceLast('bar', 'qux', 'foobar foobar'); -> 'foobar foobarqux'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#replacelast
  */
 export declare function replaceLast(search: string | number, replace: string, subject: string): string;
 /**
@@ -654,25 +548,19 @@ export declare function replaceLast(search: string | number, replace: string, su
  * @param subject - The string to perform the replacement on
  * @returns The resulting string after replacement
  *
- * @example
- *
- * replaceEnd('bar', 'qux', 'foobar foobar'); -> 'foobar fooqux'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#replaceend
  */
 export declare function replaceEnd(search: string | number, replace: string, subject: string): string;
 /**
  * Replace the patterns matching the given regular expression.
  *
  * @param pattern - The regex pattern or patterns to search for
- * @param replace - The replacement string, array of strings, or function
+ * @param replace - The replacement string, array of strings, or closure
  * @param subject - The string or array of strings to perform replacements on
  * @param limit - The maximum number of replacements per pattern (-1 for no limit)
  * @returns The resulting string, array of strings, or null on error
  *
- * @example
- *
- * replaceMatches(/foo/, 'bar', 'foobar'); -> 'barbar'
- * replaceMatches(/foo/, ['bar', 'baz'], 'foobar'); -> ['barbar', 'foobaz']
- * replaceMatches(/foo/, (match) => match[1]!.toUpperCase(), 'foobar'); -> 'Bar'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#replacematches
  */
 export declare function replaceMatches(pattern: string | string[] | RegExp | RegExp[], replace: string | string[] | ((match: string[]) => string), subject: string | string[], limit?: number): string | string[] | null;
 /**
@@ -681,9 +569,7 @@ export declare function replaceMatches(pattern: string | string[] | RegExp | Reg
  * @param value - The string to process
  * @returns The string with HTML tags removed
  *
- * @example
- *
- * stripTags("<p>Hello World</p>"); -> "Hello World"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#striptags
  */
 export declare function stripTags(value: string): string;
 /**
@@ -694,10 +580,7 @@ export declare function stripTags(value: string): string;
  * @param caseSensitive - Whether the search should be case-sensitive (default: true)
  * @returns The resulting string or array of strings after removal
  *
- * @example
- *
- * remove("foo", "foobar"); -> "bar"
- * remove(["foo", "bar"], "foobar"); -> ""
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#remove
  */
 export declare function remove(search: string | Iterable<string>, subject: string | Iterable<string>, caseSensitive?: boolean): string | string[];
 /**
@@ -706,11 +589,7 @@ export declare function remove(search: string | Iterable<string>, subject: strin
  * @param value - The string to reverse
  * @returns The reversed string
  *
- * @example
- *
- * reverse("hello"); -> "olleh"
- * reverse("world"); -> "dlrow"
- * reverse(""); -> ""
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#reverse
  */
 export declare function reverse(value: string): string;
 /**
@@ -720,11 +599,7 @@ export declare function reverse(value: string): string;
  * @param prefix - The prefix to ensure at the start
  * @returns The resulting string starting with the prefix
  *
- * @example
- *
- * start("test/string", "/"); -> "/test/string"
- * start("/test/string", "/"); -> "/test/string"
- * start("//test/string", "/"); -> "/test/string"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#start
  */
 export declare function start(value: string, prefix: string): string;
 /**
@@ -733,10 +608,7 @@ export declare function start(value: string, prefix: string): string;
  * @param value - The string to convert
  * @returns The converted string in headline case
  *
- * @example
- *
- * headline("foo bar baz"); -> "Foo Bar Baz"
- * headline("foO bAr BaZ"); -> "Foo Bar Baz"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#headline
  */
 export declare function headline(value: string): string;
 /**
@@ -745,12 +617,8 @@ export declare function headline(value: string): string;
  * @param value - The string to convert
  * @returns The converted string in APA title case
  *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#apa
  * @see https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case
- *
- * @example
- *
- * apa("foo bar baz"); -> "Foo Bar Baz"
- * apa("foO bAr BaZ"); -> "Foo Bar Baz"
  */
 export declare function apa(value: string): string;
 /**
@@ -759,6 +627,8 @@ export declare function apa(value: string): string;
  * @param value - The string to convert
  * @param delimiter - The word delimiter to use (default: "_")
  * @returns The converted string in snake case
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#snake
  */
 export declare function snake(value: string, delimiter?: string): string;
 /**
@@ -767,13 +637,8 @@ export declare function snake(value: string, delimiter?: string): string;
  * @param value - The string to process
  * @returns The resulting string with extra spaces removed
  *
- * @example
- *
- * squish(`
-    foo
-    bar
-    `); -> "foo bar"
-*/
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#squish
+ */
 export declare function squish(value: string): string;
 /**
  * Determine if a given string starts with a given substring.
@@ -782,10 +647,7 @@ export declare function squish(value: string): string;
  * @param needles - The substring or substrings to search for
  * @returns True if the haystack starts with any of the needles, false otherwise
  *
- * @example
- *
- * startsWith("hello world", "hello"); -> true
- * startsWith("hello world", "world"); -> false
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#startsWith
  */
 export declare function startsWith(haystack: string | number | null, needles: string | number | null | Iterable<string | number | null>): boolean;
 /**
@@ -795,9 +657,7 @@ export declare function startsWith(haystack: string | number | null, needles: st
  * @param needles - The substring or substrings to search for
  * @returns True if the haystack doesn't start with any of the needles, false otherwise
  *
- * @example
- *
- * expect(doesntStartWith("jason", ["day"])).toBe(true);
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#doesntstartwith
  */
 export declare function doesntStartWith(haystack: string | number | null, needles: string | number | null | Iterable<string | number | null>): boolean;
 /**
@@ -806,11 +666,7 @@ export declare function doesntStartWith(haystack: string | number | null, needle
  * @param value - The string to convert
  * @returns The converted string in studly caps case
  *
- * @example
- *
- * studly("fooBar"); -> "FooBar"
- * studly("foo_bar"); -> "FooBar"
- * studly("foo-barBaz"); -> "FooBarBaz"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#studly
  */
 export declare function studly(value: string): string;
 /**
@@ -818,6 +674,8 @@ export declare function studly(value: string): string;
  *
  * @param value - The string to convert
  * @returns The converted string in Pascal case
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#pascal
  */
 export declare function pascal(value: string): string;
 /**
@@ -827,15 +685,7 @@ export declare function pascal(value: string): string;
  * @param subject - The string to perform replacements on
  * @returns The resulting string after replacements
  *
- * @example
- *
- * swap(
- *     {
- *         'foo': 'bar',
- *         'baz': 'qux',
- *     },
- *     'foo baz'
- * ); -> 'bar qux'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#swap
  */
 export declare function swap(map: Record<string, string>, subject: string): string;
 /**
@@ -845,10 +695,7 @@ export declare function swap(map: Record<string, string>, subject: string): stri
  * @param limit - The number of characters to take (negative for from end)
  * @returns The resulting substring
  *
- * @example
- *
- * take("hello world", 5); -> "hello"
- * take("hello world", -5); -> "world"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#take
  */
 export declare function take(value: string, limit: number): string;
 /**
@@ -857,9 +704,7 @@ export declare function take(value: string, limit: number): string;
  * @param value - The string to process
  * @returns The resulting string with the first character in lowercase
  *
- * @example
- *
- * lcfirst('Hello World'); -> 'hello World'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#lcfirst
  */
 export declare function lcfirst(value: string): string;
 /**
@@ -868,9 +713,7 @@ export declare function lcfirst(value: string): string;
  * @param value - The string to process
  * @returns The resulting string with the first character in uppercase
  *
- * @example
- *
- * ucfirst('hello world'); -> 'Hello world'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#ucfirst
  */
 export declare function ucfirst(value: string): string;
 /**
@@ -879,11 +722,7 @@ export declare function ucfirst(value: string): string;
  * @param value - The string to split
  * @returns An array of string segments split at uppercase characters
  *
- * @example
- *
- * ucsplit('laravelPHPFramework'); -> ['laravel', 'P', 'H', 'P', 'Framework']
- * ucsplit('Laravel-phP-framework'); -> ['Laravel-ph', 'P-framework']
- * ucsplit('ÖffentlicheÜberraschungen'); -> ['Öffentliche', 'Überraschungen']
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#ucsplit
  */
 export declare function ucsplit(value: string): string[];
 /**
@@ -893,11 +732,7 @@ export declare function ucsplit(value: string): string[];
  * @param separators - The word separators to use (default: whitespace characters)
  * @returns The resulting string with each word capitalized
  *
- * @example
- *
- * ucwords('hello world'); -> 'Hello World'
- * ucwords('laravel php framework'); -> 'Laravel Php Framework'
- * ucwords('Öffentliche Überraschungen'); -> 'Öffentliche Überraschungen'
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#ucwords
  */
 export declare function ucwords(value: string, separators?: string | string[]): string;
 /**
@@ -907,10 +742,7 @@ export declare function ucwords(value: string, separators?: string | string[]):
  * @param characters - Additional characters to consider as part of words
  * @returns The word count in the string
  *
- * @example
- *
- * wordCount('Hello, world!'); -> 2
- * wordCount('мама мыла раму'); -> 3
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#wordcount
  */
 export declare function wordCount(value: string, characters?: string | null): number;
 /**
@@ -922,11 +754,7 @@ export declare function wordCount(value: string, characters?: string | null): nu
  * @param cutLongWords - Whether to cut words longer than the limit (default: false)
  * @returns The resulting wrapped string
  *
- * @example
- *
- * wordWrap("Hello World", 3, "<br />"); -> "Hello<br />World"
- * wordWrap("Hello World", 3, "<br />", true); -> "Hel<br />lo<br />Wor<br />ld"
- * wordWrap("❤Multi Byte☆❤☆❤☆❤", 3, "<br />"); -> "❤Multi<br />Byte☆❤☆❤☆❤"
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#wordwrap
  */
 export declare function wordWrap(value: string, characters?: number, breakStr?: string, cutLongWords?: boolean): string;
 /**