@zinaid/str 0.0.6 → 0.0.8

package/dist/{str.d.ts → str/index.d.ts}

@@ -13,6 +13,10 @@ export declare function after(subject: string, search: string | number): string;
 /**
  * Return the remainder of a string after the last occurrence of a given value.
  *
+ * @param subject - The string to search in
+ * @param search - The value to search for
+ * @returns The portion of the string after the last occurrence of the search value
+ *
  * @example
  *
  * afterLast('A house on a lake', 'a'); -> ' lake'
@@ -21,6 +25,10 @@ export declare function afterLast(subject: string, search: string | number): str
 /**
  * Get the portion of a string before the first occurrence of a given value.
  *
+ * @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
+ *
  * @example
  *
  * before('hannah', 'nah'); -> 'han'
@@ -29,6 +37,10 @@ export declare function before(subject: string, search: string | number): string
 /**
  * Get the portion of a string before the last occurrence of a given value.
  *
+ * @param subject - The string to search in
+ * @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'
@@ -37,6 +49,11 @@ export declare function beforeLast(subject: string, search: string | number): st
 /**
  * Get the portion of a string between two given values.
  *
+ * @param subject - The string to search in
+ * @param from - The starting value
+ * @param to - The ending value
+ * @returns The portion of the string between the two given values
+ *
  * @example
  *
  * between('foofoobar', 'foo', 'bar'); -> 'foo'
@@ -45,6 +62,11 @@ export declare function between(subject: string, from: string | number, to: stri
 /**
  * Get the smallest possible portion of a string between two given values.
  *
+ * @param subject - The string to search in
+ * @param from - The starting value
+ * @param to - The ending value
+ * @returns The smallest portion of the string between the two given values
+ *
  * @example
  *
  * betweenFirst('foofoobar', 'foo', 'bar'); -> 'foo'
@@ -53,6 +75,9 @@ export declare function betweenFirst(subject: string, from: string | number, to:
 /**
  * Convert a value to camel case.
  *
+ * @param value - The string to convert
+ * @returns The camel-cased string
+ *
  * @example
  *
  * camel('foo_bar'); -> 'fooBar'
@@ -61,6 +86,10 @@ export declare function camel(value: string): string;
 /**
  * Get the character at the specified index.
  *
+ * @param subject - The string to get the character from
+ * @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'
@@ -69,6 +98,10 @@ export declare function charAt(subject: string, index: number): string | false;
 /**
  * Remove the given string(s) if it exists at the start of the haystack.
  *
+ * @param subject - The string to chop from
+ * @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'
@@ -77,6 +110,10 @@ export declare function chopStart(subject: string, needle: string | string[]): s
 /**
  * Remove the given string(s) if it exists at the end of the haystack.
  *
+ * @param subject - The string to chop from
+ * @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'
@@ -99,6 +136,11 @@ export declare function contains(haystack: string, needles: string | Iterable<st
 /**
  * Extracts an excerpt from text that matches the first instance of a phrase.
  *
+ * @param text - The text to extract the excerpt from
+ * @param phrase - The phrase to search for
+ * @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 });
  */
@@ -109,6 +151,11 @@ export declare function excerpt(text: string | null, phrase?: string | null, opt
 /**
  * Determine if a given string contains all array values.
  *
+ * @param haystack - The string to search in
+ * @param needles - The substrings to search for
+ * @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
@@ -118,6 +165,11 @@ export declare function containsAll(haystack: string, needles: Iterable<string>,
 /**
  * Determine if a given string doesn't contain a given substring.
  *
+ * @param haystack - The string to search in
+ * @param needles - The substring or substrings to search for
+ * @param ignoreCase - Whether to ignore case when searching
+ * @returns True if the substring is not found, false otherwise
+ *
  * @example
  *
  * doesntContain('Minion', 'ni'); -> false
@@ -128,6 +180,10 @@ export declare function doesntContain(haystack: string, needles: string | Iterab
 /**
  * Replace consecutive instances of a given character with a single character in the given string.
  *
+ * @param value - The string to process
+ * @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'
@@ -139,6 +195,10 @@ export declare function deduplicate(value: string, character?: string | string[]
 /**
  * Determine if a given string ends with a given substring.
  *
+ * @param haystack - The string to search in
+ * @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
@@ -148,6 +208,10 @@ export declare function endsWith(haystack: string | number | null, needles: stri
 /**
  * Determine if a given string doesn't end with a given substring.
  *
+ * @param haystack - The string to search in
+ * @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
@@ -157,6 +221,10 @@ export declare function doesntEndWith(haystack: string | number | null, needles:
 /**
  * Cap a string with a single instance of a given value.
  *
+ * @param value - The string to cap
+ * @param cap - The string to cap with
+ * @returns The capped string
+ *
  * @example
  *
  * finish('hello', '!'); -> 'hello!'
@@ -165,6 +233,11 @@ export declare function finish(value: string, cap: string): string;
 /**
  * Wrap the string with the given strings.
  *
+ * @param value - The string to wrap
+ * @param before - The string to prepend
+ * @param after - The string to append (if null, use the 'before' string)
+ * @returns The wrapped string
+ *
  * @example
  *
  * wrap('hello', '[', ']'); -> '[hello]'
@@ -173,6 +246,11 @@ export declare function wrap(value: string, before: string, after?: string | nul
 /**
  * Unwrap the string with the given strings.
  *
+ * @param value - The string to unwrap
+ * @param before - The string to remove from the start
+ * @param after - The string to remove from the end (if null, use the 'before' string)
+ * @returns The unwrapped string
+ *
  * @example
  *
  * unwrap('[hello]', '[', ']'); -> 'hello'
@@ -181,6 +259,11 @@ export declare function unwrap(value: string, before: string, after?: string | n
 /**
  * Determine if a given string matches a given pattern.
  *
+ * @param pattern - The pattern or patterns to match against
+ * @param value - The string or number to check
+ * @param ignoreCase - Whether to ignore case when matching
+ * @return True if the string matches the pattern, false otherwise
+ *
  * @example
  *
  * is('hello', 'hello'); -> true
@@ -191,6 +274,9 @@ export declare function is(pattern: string | Iterable<string>, value: string | n
 /**
  * Determine if a given string is 7 bit ASCII.
  *
+ * @param value - The string to check
+ * @returns True if the string is ASCII, false otherwise
+ *
  * @example
  *
  * isAscii("Hello World"); -> true
@@ -203,6 +289,9 @@ export declare function isAscii(value: string): boolean;
 /**
  * Determine if a given value is valid JSON.
  *
+ * @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
@@ -215,6 +304,7 @@ export declare function isJson(value: unknown): boolean;
  *
  * @param value - The value to check if it's URL
  * @param protocols - An optional array of allowed protocols (e.g., ['http', 'https'])
+ * @return True if the value is a valid URL, false otherwise
  *
  * @example
  *
@@ -223,17 +313,12 @@ export declare function isJson(value: unknown): boolean;
  * isUrl('invalid url'); -> false
  */
 export declare function isUrl(value: string | unknown, protocols?: string[]): boolean;
-/**
- * Determine if a given value is a valid ULID.
- *
- * @example
- *
- * isUlid("01F8MECHZX2D7J8F8C8D4B8F8C"); -> true
- */
-export declare function isUlid(value: unknown): boolean;
 /**
  * Convert a string to kebab case.
  *
+ * @param value - The string to convert
+ * @returns The kebab-cased string
+ *
  * @example
  *
  * kebab("Laravel PHP Framework"); -> "laravel-php-framework"
@@ -242,6 +327,9 @@ export declare function kebab(value: string): string;
 /**
  * Return the length of the given string.
  *
+ * @param value - The string to measure
+ * @returns The length of the string
+ *
  * @example
  *
  * length("Hello World"); -> 11
@@ -250,16 +338,19 @@ export declare function length(value: string): number;
 /**
  * Limit the number of characters in a string.
  *
- * @param  string  $value
- * @param  int  $limit
- * @param  string  $end
- * @param  bool  $preserveWords
- * @return string
+ * @param value - The string to limit
+ * @param limit - The maximum number of characters
+ * @param end - The string to append if the value is truncated
+ * @param preserveWords - Whether to preserve whole words when truncating
+ * @returns The limited string
  */
 export declare function limit(value: string, limit?: number, end?: string, preserveWords?: boolean): string;
 /**
  * Convert the given string to lower-case.
  *
+ * @param value - The string to convert
+ * @returns The lower-cased string
+ *
  * @example
  *
  * lower("Hello World"); -> "hello world"
@@ -268,6 +359,11 @@ export declare function lower(value: string): string;
 /**
  * Limit the number of words in a string.
  *
+ * @param value - The string to limit
+ * @param words - The maximum number of words
+ * @param end - The string to append if the value is truncated
+ * @returns The limited string
+ *
  * @example
  *
  * words("Laravel PHP Framework", 2); -> "Laravel PHP Framework"
@@ -277,6 +373,12 @@ export declare function words(value: string, words?: number, end?: string): stri
 /**
  * Masks a portion of a string with a repeated character.
  *
+ * @param value - The string to mask
+ * @param character - The character to use for masking
+ * @param index - The starting index to begin masking (can be negative)
+ * @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*************"
@@ -288,14 +390,18 @@ export declare function mask(value: string, character: string, index: number, le
 /**
  * Get the string matching the given pattern.
  *
- * @param  string  $pattern
- * @param  string  $subject
- * @return string
+ * @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
  */
 export declare function match(pattern: string, subject: string): string;
 /**
  * Determine if a given string matches a given pattern.
  *
+ * @param pattern - The pattern or patterns to match against
+ * @param value - The string to check
+ * @return True if the string matches the pattern, false otherwise
+ *
  * @example
  *
  * Str::isMatch('/foo/', 'foo bar'); // true
@@ -305,6 +411,10 @@ export declare function isMatch(pattern: string | Iterable<string>, value: strin
 /**
  * Get the string 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"]
@@ -313,6 +423,9 @@ export declare function matchAll(pattern: string, subject: string): string[];
 /**
  * Remove all non-numeric characters from a string.
  *
+ * @param value - The string or array of strings to process
+ * @returns The numeric-only string or array of strings
+ *
  * @example
  *
  * numbers("foo123bar"); -> "123"
@@ -322,15 +435,20 @@ export declare function numbers(value: string | string[]): string | string[];
 /**
  * Pad both sides of a string with another.
  *
- * @param  string  $value
- * @param  int  $length
- * @param  string  $pad
- * @return string
+ * @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
  */
 export declare function padBoth(value: string, length: number, pad?: string): string;
 /**
  * Pad the left side of a string with another.
  *
+ * @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"
@@ -342,6 +460,11 @@ export declare function padLeft(value: string, length: number, pad?: string): st
 /**
  * Pad the right side of a string with another.
  *
+ * @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-=-="
@@ -353,6 +476,10 @@ export declare function padRight(value: string, length: number, pad?: string): s
 /**
  * Create a padding string.
  *
+ * @param padStr - The string to use for padding
+ * @param needed - The total length of padding needed
+ * @returns The generated padding string
+ *
  * @example
  *
  * makePad(" ", 5); -> "     "
@@ -360,22 +487,6 @@ export declare function padRight(value: string, length: number, pad?: string): s
  * makePad("❤", 5); -> "❤❤❤❤❤"
  */
 export declare function makePad(padStr: string, needed: number): string;
-/**
- * Pluralize the last word of an English, studly caps case string.
- *
- * @example
- *
- * pluralStudly("These are the school", 4); -> "These are the schools"
- */
-export declare function pluralStudly(value: string, count?: number): string;
-/**
- * Pluralize the last word of an English, Pascal caps case string.
- *
- * @example
- *
- * pluralPascal("These are the school", 4); -> "These are the schools"
- */
-export declare function pluralPascal(value: string, count?: number): string;
 /**
  * Generate a random, secure password.
  *
@@ -395,6 +506,11 @@ export declare function password(length?: number, letters?: boolean, numbers?: b
 /**
  * Find the multi-byte safe position of the first occurrence of a given substring in a string.
  *
+ * @param haystack - The string to search within
+ * @param needle - The substring to search for
+ * @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
@@ -404,6 +520,9 @@ export declare function position(haystack: string, needle: string, offset?: numb
 /**
  * Generate a more truly "random" alpha-numeric string.
  *
+ * @param length - The desired length of the random string (default: 16)
+ * @returns The generated random string
+ *
  * @example
  *
  * random(); -> "a1b2c3d4e5f6g7h8"
@@ -412,6 +531,9 @@ export declare function random(length?: number): string;
 /**
  * Set the callable that will be used to generate random strings.
  *
+ * @param factory - The factory function to generate random strings
+ * @returns void
+ *
  * @example
  *
  * createRandomStringsUsing((length) => "x".repeat(length));
@@ -420,6 +542,10 @@ export declare function createRandomStringsUsing(factory: ((length: number) => s
 /**
  * Set the sequence that will be used to generate random strings.
  *
+ * @param sequence - An array of strings to use in sequence
+ * @param whenMissing - An optional callable to generate strings when the sequence is exhausted
+ * @returns void
+ *
  * @example
  *
  * createRandomStringsUsingSequence(['a', 'b', 'c']);
@@ -429,6 +555,8 @@ export declare function createRandomStringsUsingSequence(sequence: string[], whe
 /**
  * Indicate that random strings should be created normally and not using a custom factory.
  *
+ * @returns void
+ *
  * @example
  *
  * createRandomStringsNormally();
@@ -437,6 +565,10 @@ export declare function createRandomStringsNormally(): void;
 /**
  * Repeat the given string.
  *
+ * @param string - The string to repeat
+ * @param times - The number of times to repeat the string
+ * @returns The repeated string
+ *
  * @example
  *
  * repeat("foo", 3); -> "foofoofoo"
@@ -445,6 +577,11 @@ export declare function repeat(string: string, times: number): string;
 /**
  * Replace a given value in the string sequentially with an array.
  *
+ * @param search - The value to search for
+ * @param replace - The array or record of replacements
+ * @param subject - The string to perform replacements on
+ * @returns The resulting string after replacements
+ *
  * @example
  *
  * replaceArray('?', ['foo', 'bar', 'baz'], '?/?/?'); -> 'foo/bar/baz'
@@ -455,6 +592,10 @@ export declare function replaceArray(search: string, replace: Record<string, str
 /**
  * Convert the given value to a string or return the given fallback on failure.
  *
+ * @param value - The value to convert
+ * @param fallback - The fallback string to return on failure
+ * @returns The converted string or the fallback
+ *
  * @example
  *
  * toStringOr(123);
@@ -463,6 +604,12 @@ export declare function toStringOr(value: unknown, fallback: string): string;
 /**
  * Replace the given value in the given string.
  *
+ * @param search - The value or values to search for
+ * @param replacement - The value or values to replace with
+ * @param subject - The string or array of strings to perform replacements on
+ * @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"
@@ -471,6 +618,11 @@ export declare function replace<T extends string | Iterable<string>>(search: str
 /**
  * Replace the first occurrence of a given value in the string.
  *
+ * @param search - The value to search for
+ * @param replace - The value to replace with
+ * @param subject - The string to perform the replacement on
+ * @returns The resulting string after replacement
+ *
  * @example
  *
  * replaceFirst('bar', 'qux', 'foobar foobar'); -> 'fooqux foobar'
@@ -479,15 +631,20 @@ export declare function replaceFirst(search: string | number, replace: string, s
 /**
  * Replace the first occurrence of the given value if it appears at the start of the string.
  *
- * @param  string  $search
- * @param  string  $replace
- * @param  string  $subject
- * @return string
+ * @param search - The value to search for
+ * @param replace - The value to replace with
+ * @param subject - The string to perform the replacement on
+ * @returns The resulting string after replacement
  */
 export declare function replaceStart(search: string | number, replace: string, subject: string): string;
 /**
  * Replace the last occurrence of a given value in the string.
  *
+ * @param search - The value to search for
+ * @param replace - The value to replace with
+ * @param subject - The string to perform the replacement on
+ * @returns The resulting string after replacement
+ *
  * @example
  *
  * replaceLast('bar', 'qux', 'foobar foobar'); -> 'foobar foobarqux'
@@ -496,6 +653,11 @@ export declare function replaceLast(search: string | number, replace: string, su
 /**
  * Replace the last occurrence of a given value if it appears at the end of the string.
  *
+ * @param search - The value to search for
+ * @param replace - The value to replace with
+ * @param subject - The string to perform the replacement on
+ * @returns The resulting string after replacement
+ *
  * @example
  *
  * replaceEnd('bar', 'qux', 'foobar foobar'); -> 'foobar fooqux'
@@ -504,6 +666,12 @@ export declare function replaceEnd(search: string | number, replace: string, sub
 /**
  * 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 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'
@@ -514,6 +682,9 @@ export declare function replaceMatches(pattern: string | string[] | RegExp | Reg
 /**
  * Strip HTML tags from a string.
  *
+ * @param value - The string to process
+ * @returns The string with HTML tags removed
+ *
  * @example
  *
  * stripTags("<p>Hello World</p>"); -> "Hello World"
@@ -522,6 +693,11 @@ export declare function stripTags(value: string): string;
 /**
  * Remove any occurrence of the given string in the subject.
  *
+ * @param search - The string or strings to remove
+ * @param subject - The string or strings to process
+ * @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"
@@ -531,6 +707,9 @@ export declare function remove(search: string | Iterable<string>, subject: strin
 /**
  * Reverse the given string.
  *
+ * @param value - The string to reverse
+ * @returns The reversed string
+ *
  * @example
  *
  * reverse("hello"); -> "olleh"
@@ -541,6 +720,10 @@ export declare function reverse(value: string): string;
 /**
  * Begin a string with a single instance of a given value.
  *
+ * @param value - The string to process
+ * @param prefix - The prefix to ensure at the start
+ * @returns The resulting string starting with the prefix
+ *
  * @example
  *
  * start("test/string", "/"); -> "/test/string"
@@ -551,6 +734,9 @@ export declare function start(value: string, prefix: string): string;
 /**
  * Convert the given string to proper case for each word.
  *
+ * @param value - The string to convert
+ * @returns The converted string in headline case
+ *
  * @example
  *
  * headline("foo bar baz"); -> "Foo Bar Baz"
@@ -560,7 +746,10 @@ export declare function headline(value: string): string;
 /**
  * Convert the given string to APA-style title case.
  *
- * See: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case
+ * @param value - The string to convert
+ * @returns The converted string in APA title case
+ *
+ * @see https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case
  *
  * @example
  *
@@ -568,37 +757,35 @@ export declare function headline(value: string): string;
  * apa("foO bAr BaZ"); -> "Foo Bar Baz"
  */
 export declare function apa(value: string): string;
-/**
- * Generate a URL friendly "slug" from a given string.
- *
- * @param  string  $title
- * @param  string  $separator
- * @param  array<string, string>  $dictionary
- * @return string
- */
-export declare function slug(title: string, separator?: string, dictionary?: Record<string, string>): string;
 /**
  * Convert a string to snake case.
  *
- * @param  string  $value
- * @param  string  $delimiter
- * @return string
+ * @param value - The string to convert
+ * @param delimiter - The word delimiter to use (default: "_")
+ * @returns The converted string in snake case
  */
 export declare function snake(value: string, delimiter?: string): string;
 /**
-     * Remove all "extra" blank space from the given string.
-     *
-     * @example
-     *
-     * squish(`
-        foo
-        bar
-       `); -> "foo bar"
-     */
+ * Remove all "extra" blank space from the given string.
+ *
+ * @param value - The string to process
+ * @returns The resulting string with extra spaces removed
+ *
+ * @example
+ *
+ * squish(`
+    foo
+    bar
+    `); -> "foo bar"
+*/
 export declare function squish(value: string): string;
 /**
  * Determine if a given string starts with a given substring.
  *
+ * @param haystack - The string to search in
+ * @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
@@ -608,6 +795,10 @@ export declare function startsWith(haystack: string | number | null, needles: st
 /**
  * Determine if a given string doesn't start with a given substring.
  *
+ * @param haystack - The string to search in
+ * @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);
@@ -616,6 +807,9 @@ export declare function doesntStartWith(haystack: string | number | null, needle
 /**
  * Convert a value to studly caps case.
  *
+ * @param value - The string to convert
+ * @returns The converted string in studly caps case
+ *
  * @example
  *
  * studly("fooBar"); -> "FooBar"
@@ -626,13 +820,17 @@ export declare function studly(value: string): string;
 /**
  * Convert a value to Pascal case.
  *
- * @param  string  $value
- * @return string
+ * @param value - The string to convert
+ * @returns The converted string in Pascal case
  */
 export declare function pascal(value: string): string;
 /**
  * Swap multiple keywords in a string with other keywords.
  *
+ * @param map - The record of replacements
+ * @param subject - The string to perform replacements on
+ * @returns The resulting string after replacements
+ *
  * @example
  *
  * swap(
@@ -647,6 +845,10 @@ export declare function swap(map: Record<string, string>, subject: string): stri
 /**
  * Take the first or last {$limit} characters of a string.
  *
+ * @param value - The string to process
+ * @param limit - The number of characters to take (negative for from end)
+ * @returns The resulting substring
+ *
  * @example
  *
  * take("hello world", 5); -> "hello"
@@ -656,6 +858,9 @@ export declare function take(value: string, limit: number): string;
 /**
  * Make a string's first character lowercase.
  *
+ * @param value - The string to process
+ * @returns The resulting string with the first character in lowercase
+ *
  * @example
  *
  * lcfirst('Hello World'); -> 'hello World'
@@ -664,6 +869,9 @@ export declare function lcfirst(value: string): string;
 /**
  * Make a string's first character uppercase.
  *
+ * @param value - The string to process
+ * @returns The resulting string with the first character in uppercase
+ *
  * @example
  *
  * ucfirst('hello world'); -> 'Hello world'
@@ -672,6 +880,9 @@ export declare function ucfirst(value: string): string;
 /**
  * Split a string into pieces by uppercase characters.
  *
+ * @param value - The string to split
+ * @returns An array of string segments split at uppercase characters
+ *
  * @example
  *
  * ucsplit('laravelPHPFramework'); -> ['laravel', 'P', 'H', 'P', 'Framework']
@@ -682,6 +893,10 @@ export declare function ucsplit(value: string): string[];
 /**
  * Uppercase the first letter of each word in a string.
  *
+ * @param value - The string to process
+ * @param separators - The word separators to use (default: whitespace characters)
+ * @returns The resulting string with each word capitalized
+ *
  * @example
  *
  * ucwords('hello world'); -> 'Hello World'
@@ -692,6 +907,10 @@ export declare function ucwords(value: string, separators?: string | string[]):
 /**
  * Get the number of words a string contains.
  *
+ * @param value - The string to analyze
+ * @param characters - Additional characters to consider as part of words
+ * @returns The word count in the string
+ *
  * @example
  *
  * wordCount('Hello, world!'); -> 2
@@ -701,6 +920,12 @@ export declare function wordCount(value: string, characters?: string | null): nu
 /**
  * Wrap a string to a given number of characters.
  *
+ * @param value - The string to wrap
+ * @param characters - The maximum number of characters per line (default: 75)
+ * @param breakStr - The string to insert as a line break (default: "\n")
+ * @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"
@@ -711,6 +936,8 @@ export declare function wordWrap(value: string, characters?: number, breakStr?:
 /**
  * Get the size of the snake cache.
  *
+ * @returns The size of the snake cache
+ *
  * @example
  *
  * snakeCacheSize();
@@ -719,6 +946,8 @@ export declare function snakeCacheSize(): number;
 /**
  * Get the size of the camel cache.
  *
+ * @returns The size of the camel cache
+ *
  * @example
  *
  * camelCacheSize();
@@ -727,6 +956,8 @@ export declare function camelCacheSize(): number;
 /**
  * Get the size of the studly cache.
  *
+ * @returns The size of the studly cache
+ *
  * @example
  *
  * studlyCacheSize();
@@ -735,7 +966,7 @@ export declare function studlyCacheSize(): number;
 /**
  * Remove all strings from the casing caches.
  *
- * @return void
+ * @returns void
  */
 export declare function flushCache(): void;
-//# sourceMappingURL=str.d.ts.map
+//# sourceMappingURL=index.d.ts.map