@tolki/str 1.0.0

package/dist/str.d.ts

@@ -0,0 +1,968 @@
+/**
+ * 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
+ *
+ * @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;
+/**
+ * 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
+ *
+ * @see https://tolki.abe.dev/strings/string-utilities-list.html#afterLast
+ */
+export declare function afterLast(subject: string, search: string | number): string;
+/**
+ * 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
+ */
+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'
+ */
+export declare function beforeLast(subject: string, search: string | number): string;
+/**
+ * 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'
+ */
+export declare function between(subject: string, from: string | number, to: string | number): string;
+/**
+ * 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'
+ */
+export declare function betweenFirst(subject: string, from: string | number, to: string | number): string;
+/**
+ * Convert a value to camel case.
+ *
+ * @param value - The string to convert
+ * @returns The camel-cased string
+ *
+ * @example
+ *
+ * camel('foo_bar'); -> 'fooBar'
+ */
+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'
+ */
+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'
+ */
+export declare function chopStart(subject: string, needle: string | string[]): string;
+/**
+ * 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'
+ */
+export declare function chopEnd(subject: string, needle: string | string[]): string;
+/**
+ * Determine if a given string contains 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
+ *
+ * @example
+ *
+ * contains('Minion', 'ni'); -> true
+ * contains('Minion', 'Ni', true); -> true
+ * contains('Minion', 'Ni', false); -> false
+ */
+export declare function contains(haystack: string, needles: string | Iterable<string>, ignoreCase?: boolean): boolean;
+/**
+ * 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 });
+ */
+export declare function excerpt(text: string | null, phrase?: string | null, options?: {
+    radius?: number;
+    omission?: string;
+}): string | null;
+/**
+ * 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
+ * containsAll('Taylor Otwell', ['taylor', 'xxx'], true); -> false
+ */
+export declare function containsAll(haystack: string, needles: Iterable<string>, ignoreCase?: boolean): boolean;
+/**
+ * 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
+ * doesntContain('Minion', 'Ni', true); -> false
+ * doesntContain('Minion', 'Ni', false); -> true
+ */
+export declare function doesntContain(haystack: string, needles: string | Iterable<string>, ignoreCase?: boolean): boolean;
+/**
+ * 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'
+ * deduplicate('hello---world', '-'); -> 'hello-world'
+ * deduplicate('hello___world', '_'); -> 'hello-world'
+ * deduplicate('hello  world', ' '); -> 'hello world'
+ */
+export declare function deduplicate(value: string, character?: string | 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
+ * endsWith("Jason", "ON"); -> false
+ */
+export declare function endsWith(haystack: string | number | null, needles: string | number | Iterable<string>): boolean;
+/**
+ * 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
+ * doesntEndWith("Jason", "ON"); -> true
+ */
+export declare function doesntEndWith(haystack: string | number | null, needles: string | number | Iterable<string>): boolean;
+/**
+ * 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!'
+ */
+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]'
+ */
+export declare function wrap(value: string, before: string, after?: string | null): string;
+/**
+ * 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'
+ */
+export declare function unwrap(value: string, before: string, after?: string | null): string;
+/**
+ * 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
+ * is('hello', 'Hello', true); -> true
+ * is('hello', 'world'); -> false
+ */
+export declare function is(pattern: string | Iterable<string>, value: string | number, ignoreCase?: boolean): boolean;
+/**
+ * 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
+ * isAscii("こんにちは"); -> false
+ * isAscii("12345"); -> true
+ * isAscii("!@#$%"); -> true
+ * isAscii("Hello こんにちは"); -> false
+ */
+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
+ * isJson('{"name": "John", "age": 30'); -> false
+ * isJson('Hello World'); -> false
+ */
+export declare function isJson(value: unknown): boolean;
+/**
+ * Determine if a given value is a valid URL.
+ *
+ * @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
+ *
+ * isUrl('https://laravel.com'); -> true
+ * isUrl('http://localhost'); -> true
+ * isUrl('invalid url'); -> false
+ */
+export declare function isUrl(value: string | unknown, protocols?: string[]): 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"
+ */
+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
+ */
+export declare function length(value: string): number;
+/**
+ * Limit the number of characters in a 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"
+ */
+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"
+ * words("Laravel PHP Framework", 1); -> "Laravel..."
+ */
+export declare function words(value: string, words?: number, end?: string): string;
+/**
+ * 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*************"
+ * mask("taylor@email.com", "*", 0, 6); -> "******@email.com"
+ * mask("taylor@email.com", "*", -13); -> "tay*************"
+ * mask("taylor@email.com", "*", -13, 3); -> "tay***@email.com"
+ */
+export declare function mask(value: string, character: string, index: number, length?: number | null): string;
+/**
+ * Get the string matching the given pattern.
+ *
+ * @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
+ * Str::isMatch('/bar/', 'foo bar'); // false
+ */
+export declare function isMatch(pattern: string | Iterable<string>, value: string): boolean;
+/**
+ * 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"]
+ */
+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"
+ * numbers(["foo123bar", "abc456"]); -> ["123", "456"]
+ */
+export declare function numbers(value: string | string[]): string | string[];
+/**
+ * Pad both sides 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
+ */
+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"
+ * padLeft("Alien", 10); -> "     Alien"
+ * padLeft("❤MultiByte☆", 16); -> "     ❤MultiByte☆"
+ * padLeft("❤MultiByte☆", 16, "❤☆"); -> "❤☆❤☆❤❤MultiByte☆"
+ */
+export declare function padLeft(value: string, length: number, pad?: string): string;
+/**
+ * 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-=-="
+ * padRight("Alien", 10); -> "Alien     "
+ * padRight("❤MultiByte☆", 16); -> "❤MultiByte☆     "
+ * padRight("❤MultiByte☆", 16, "❤☆"); -> "❤MultiByte☆❤☆❤☆"
+ */
+export declare function padRight(value: string, length: number, pad?: string): string;
+/**
+ * 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); -> "     "
+ * makePad("-", 5); -> "-----"
+ * makePad("❤", 5); -> "❤❤❤❤❤"
+ */
+export declare function makePad(padStr: string, needed: number): string;
+/**
+ * Generate a random, secure password.
+ *
+ * Mirrors Laravel's Str::password behavior:
+ * - Ensures at least one character from each enabled set
+ * - Uses a combined pool for remaining characters
+ * - Shuffles result and returns a string of requested length
+ *
+ * @param length The desired length of the password (default: 32)
+ * @param letters Whether to include letters (default: true)
+ * @param numbers Whether to include numbers (default: true)
+ * @param symbols Whether to include symbols (default: true)
+ * @param spaces Whether to include spaces (default: false)
+ * @return The generated password string
+ */
+export declare function password(length?: number, letters?: boolean, numbers?: boolean, symbols?: boolean, spaces?: boolean): string;
+/**
+ * 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
+ * position('Hello, World!', 'world!', 0); -> false
+ */
+export declare function position(haystack: string, needle: string, offset?: number): number | false;
+/**
+ * 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"
+ */
+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));
+ */
+export declare function createRandomStringsUsing(factory: ((length: number) => string) | null): void;
+/**
+ * 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']);
+ * createRandomStringsUsingSequence(['x', 'y', 'z'], (length) => "z".repeat(length));
+ */
+export declare function createRandomStringsUsingSequence(sequence: string[], whenMissing?: (length: number) => string): void;
+/**
+ * Indicate that random strings should be created normally and not using a custom factory.
+ *
+ * @returns void
+ *
+ * @example
+ *
+ * createRandomStringsNormally();
+ */
+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"
+ */
+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'
+ * replaceArray('?', ['foo', 'bar', 'baz'], '?/?/?/?'); -> 'foo/bar/baz/?'
+ * replaceArray('?', {'x' => 'foo', 'y' => 'bar'}, '?/?'); -> 'foo/bar'
+ */
+export declare function replaceArray(search: string, replace: Record<string, string> | Iterable<string>, subject: string): string;
+/**
+ * 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);
+ */
+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"
+ */
+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[];
+/**
+ * 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'
+ */
+export declare function replaceFirst(search: string | number, replace: string, subject: string): string;
+/**
+ * Replace the first occurrence of the given value if it appears at the start 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
+ */
+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'
+ */
+export declare function replaceLast(search: string | number, replace: string, subject: string): string;
+/**
+ * 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'
+ */
+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 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'
+ */
+export declare function replaceMatches(pattern: string | string[] | RegExp | RegExp[], replace: string | string[] | ((match: string[]) => string), subject: string | string[], limit?: number): string | string[] | null;
+/**
+ * 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"
+ */
+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"
+ * remove(["foo", "bar"], "foobar"); -> ""
+ */
+export declare function remove(search: string | Iterable<string>, subject: string | Iterable<string>, caseSensitive?: boolean): string | string[];
+/**
+ * Reverse the given string.
+ *
+ * @param value - The string to reverse
+ * @returns The reversed string
+ *
+ * @example
+ *
+ * reverse("hello"); -> "olleh"
+ * reverse("world"); -> "dlrow"
+ * reverse(""); -> ""
+ */
+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"
+ * start("/test/string", "/"); -> "/test/string"
+ * start("//test/string", "/"); -> "/test/string"
+ */
+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"
+ * headline("foO bAr BaZ"); -> "Foo Bar Baz"
+ */
+export declare function headline(value: string): string;
+/**
+ * Convert the given string to APA-style 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
+ *
+ * apa("foo bar baz"); -> "Foo Bar Baz"
+ * apa("foO bAr BaZ"); -> "Foo Bar Baz"
+ */
+export declare function apa(value: string): string;
+/**
+ * Convert a string to snake case.
+ *
+ * @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.
+ *
+ * @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
+ * startsWith("hello world", "world"); -> false
+ */
+export declare function startsWith(haystack: string | number | null, needles: string | number | null | Iterable<string | number | null>): boolean;
+/**
+ * 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);
+ */
+export declare function doesntStartWith(haystack: string | number | null, needles: string | number | null | Iterable<string | number | null>): boolean;
+/**
+ * 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"
+ * studly("foo_bar"); -> "FooBar"
+ * studly("foo-barBaz"); -> "FooBarBaz"
+ */
+export declare function studly(value: string): string;
+/**
+ * Convert a value to Pascal case.
+ *
+ * @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(
+ *     {
+ *         'foo': 'bar',
+ *         'baz': 'qux',
+ *     },
+ *     'foo baz'
+ * ); -> 'bar qux'
+ */
+export declare function swap(map: Record<string, string>, subject: string): string;
+/**
+ * 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"
+ * take("hello world", -5); -> "world"
+ */
+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'
+ */
+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'
+ */
+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']
+ * ucsplit('Laravel-phP-framework'); -> ['Laravel-ph', 'P-framework']
+ * ucsplit('ÖffentlicheÜberraschungen'); -> ['Öffentliche', 'Überraschungen']
+ */
+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'
+ * ucwords('laravel php framework'); -> 'Laravel Php Framework'
+ * ucwords('Öffentliche Überraschungen'); -> 'Öffentliche Überraschungen'
+ */
+export declare function ucwords(value: string, separators?: string | 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
+ * wordCount('мама мыла раму'); -> 3
+ */
+export declare function wordCount(value: string, characters?: string | null): number;
+/**
+ * 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"
+ * wordWrap("Hello World", 3, "<br />", true); -> "Hel<br />lo<br />Wor<br />ld"
+ * wordWrap("❤Multi Byte☆❤☆❤☆❤", 3, "<br />"); -> "❤Multi<br />Byte☆❤☆❤☆❤"
+ */
+export declare function wordWrap(value: string, characters?: number, breakStr?: string, cutLongWords?: boolean): string;
+/**
+ * Get the size of the snake cache.
+ *
+ * @returns The size of the snake cache
+ *
+ * @example
+ *
+ * snakeCacheSize();
+ */
+export declare function snakeCacheSize(): number;
+/**
+ * Get the size of the camel cache.
+ *
+ * @returns The size of the camel cache
+ *
+ * @example
+ *
+ * camelCacheSize();
+ */
+export declare function camelCacheSize(): number;
+/**
+ * Get the size of the studly cache.
+ *
+ * @returns The size of the studly cache
+ *
+ * @example
+ *
+ * studlyCacheSize();
+ */
+export declare function studlyCacheSize(): number;
+/**
+ * Remove all strings from the casing caches.
+ *
+ * @returns void
+ */
+export declare function flushCache(): void;
+//# sourceMappingURL=str.d.ts.map