@turndown/library 0.1.24 → 0.1.29

package/dist/helpers/string/index.d.ts

@@ -1,258 +0,0 @@
-/**
- * String utilities for common text manipulation tasks.
- */
-import { TUSStateCode } from "@/types";
-/**
- * Adds commas to a number for thousands separators.
- *
- * @example formatNumber(1000) => '1,000'
- * @example formatNumber('1234567') => '1,234,567'
- * @example formatNumber(1234567.89) => '1,234,567.89'
- */
-export declare const formatNumber: (value: string | number) => string;
-export declare const normalCase: (str?: string) => string;
-export declare const sentenceCase: (str?: string) => string;
-export declare const upperCase: (str?: string) => string;
-export declare const lowerCase: (str?: string) => string;
-/**
- * Converts a string to camelCase.
- *
- * @example toCamelCase('hello-world') => 'helloWorld'
- * @example toCamelCase('hello_world') => 'helloWorld'
- */
-export declare const toCamelCase: (str: string) => string;
-export declare const camelCase: (str: string) => string;
-/**
- * Converts a string to kebab-case.
- *
- * @example toKebabCase('helloWorld') => 'hello-world'
- * @example toKebabCase('Hello_World') => 'hello-world'
- */
-export declare const toKebabCase: (str: string) => string;
-export declare const kebabCase: (str: string) => string;
-/**
- * Converts a string to snake_case.
- *
- * @example toSnakeCase('helloWorld') => 'hello_world'
- * @example toSnakeCase('hello-world') => 'hello_world'
- */
-export declare const toSnakeCase: (str: string) => string;
-export declare const snakeCase: (str: string) => string;
-/**
- * Converts a string to PascalCase.
- *
- * @example toPascalCase('hello-world') => 'HelloWorld'
- * @example toPascalCase('hello_world') => 'HelloWorld'
- */
-export declare const toPascalCase: (str: string) => string;
-export declare const pascalCase: (str: string) => string;
-export declare const snakeCaseToSpaces: (str: string) => string;
-export declare const kebabToSpaces: (str: string) => string;
-/**
- * Capitalizes the first character of a string.
- *
- * @example capitalize('hello world') => 'Hello world'
- */
-export declare const capitalize: (str: string) => string;
-/**
- * Capitalizes the first letter of each word.
- *
- * @example titleCase('hello world') => 'Hello World'
- */
-export declare const titleCase: (str: string) => string;
-/**
- * Truncates a string to a specified length and adds ellipsis.
- *
- * @example truncate('hello world', 5) => 'he...'
- */
-export declare const truncate: (str: string, length: number, suffix?: string) => string;
-/**
- * Removes all whitespace from a string.
- *
- * @example removeWhitespace('hello world') => 'helloworld'
- */
-export declare const removeWhitespace: (str: string) => string;
-/**
- * Removes all non-alphanumeric characters.
- *
- * @example removeSpecialChars('hello@world#123') => 'helloworld123'
- */
-export declare const removeSpecialChars: (str: string) => string;
-/**
- * Generates a URL-friendly slug from a string.
- *
- * @example slug('Hello World 2024!') => 'hello-world-2024'
- */
-export declare const slug: (str: string) => string;
-/**
- * Validates if a string is a valid email.
- *
- * @example isEmail('user@example.com') => true
- */
-export declare const isEmail: (str: string) => boolean;
-/**
- * Validates if a string is a valid URL.
- *
- * @example isUrl('https://example.com') => true
- */
-export declare const isUrl: (str: string) => boolean;
-/**
- * Validates if a string contains only numbers.
- *
- * @example isNumeric('12345') => true
- * @example isNumeric('123abc') => false
- */
-export declare const isNumeric: (str: string) => boolean;
-/**
- * Checks if a string is empty or contains only whitespace.
- *
- * @example isEmpty('  ') => true
- * @example isEmpty('hello') => false
- */
-export declare const isEmpty: (str: string) => boolean;
-/**
- * Reverses a string.
- *
- * @example reverse('hello') => 'olleh'
- */
-export declare const reverse: (str: string) => string;
-/**
- * Repeats a string a specified number of times.
- *
- * @example repeat('ab', 3) => 'ababab'
- */
-export declare const repeat: (str: string, times: number) => string;
-/**
- * Pads a string to a specified length.
- *
- * @example padStart('5', 3, '0') => '005'
- * @example padEnd('5', 3, '0') => '500'
- */
-export declare const padStart: (str: string, length: number, padChar?: string) => string;
-export declare const padEnd: (str: string, length: number, padChar?: string) => string;
-/**
- * Encodes a string to Base64.
- *
- * @example toBase64('hello') => 'aGVsbG8='
- */
-export declare const toBase64: (str: string) => string;
-/**
- * Decodes a Base64 string.
- *
- * @example fromBase64('aGVsbG8=') => 'hello'
- */
-export declare const fromBase64: (str: string) => string;
-/**
- * Counts the number of words in a string.
- *
- * @example wordCount('hello world test') => 3
- */
-export declare const wordCount: (str: string) => number;
-/**
- * Counts the number of characters, excluding whitespace.
- *
- * @example charCount('hello world') => 10
- */
-export declare const charCount: (str: string) => number;
-/**
- * Repeats a character a specified number of times.
- *
- * @example repeatChar('*', 5) => '*****'
- */
-export declare const repeatChar: (char: string, times: number) => string;
-/**
- * Extracts numbers from a string.
- *
- * @example extractNumbers('abc123def456') => '123456'
- */
-export declare const extractNumbers: (str: string) => string;
-/**
- * Removes duplicate consecutive characters.
- *
- * @example removeDuplicates('aabbccdd') => 'abcd'
- */
-export declare const removeDuplicates: (str: string) => string;
-/**
- * Checks if a string is a palindrome.
- *
- * @example isPalindrome('racecar') => true
- * @example isPalindrome('hello') => false
- */
-export declare const isPalindrome: (str: string) => boolean;
-/**
- * Finds the longest word in a string.
- *
- * @example longestWord('the quick brown fox') => 'quick'
- */
-export declare const longestWord: (str: string) => string;
-/**
- * Pluralizes common English words using a simple ruleset.
- *
- * @example pluralize('cat') => 'cats'
- * @example pluralize('box') => 'boxes'
- */
-export declare const pluralize: (word: string) => string;
-/**
- * Highlights a substring within a string by wrapping it with markers.
- *
- * @example highlight('hello world', 'world', '**') => 'hello **world**'
- */
-export declare const highlight: (str: string, substring: string, marker?: string) => string;
-/**
- * Converts a string to a regex-safe string.
- *
- * @example escapeRegex('a.b*c') => 'a\\.b\\*c'
- */
-export declare const escapeRegex: (str: string) => string;
-/**
- * Finds similarity between two strings using Levenshtein distance.
- * Returns a value between 0 and 1, where 1 means identical.
- *
- * @example stringSimilarity('hello', 'hallo') => 0.8
- */
-export declare const stringSimilarity: (str1: string, str2: string) => number;
-/**
- * Strips HTML tags from a string.
- *
- * @example stripHtml('<p>Hello <b>world</b></p>') => 'Hello world'
- */
-export declare const stripHtml: (str: string) => string;
-/**
- * Replaces multiple spaces with a single space.
- *
- * @example normalizeSpaces('hello    world') => 'hello world'
- */
-export declare const normalizeSpaces: (str: string) => string;
-/**
- * Converts a string to a number, returning null if not valid.
- *
- * @example toNumber('123') => 123
- * @example toNumber('abc') => null
- */
-export declare const toNumber: (str: string) => number | null;
-/**
- * Splits a string by multiple delimiters.
- *
- * @example splitMultiple('a,b;c:d', ',', ';', ':') => ['a', 'b', 'c', 'd']
- */
-export declare const splitMultiple: (str: string, ...delimiters: string[]) => string[];
-/**
- * Checks if a string contains any of the provided substrings.
- *
- * @example containsAny('hello world', 'foo', 'world') => true
- */
-export declare const containsAny: (str: string, ...substrings: string[]) => boolean;
-/**
- * Checks if a string contains all of the provided substrings.
- *
- * @example containsAll('hello world', 'hello', 'world') => true
- */
-export declare const containsAll: (str: string, ...substrings: string[]) => boolean;
-export interface IAddress {
-    addressLine1: string;
-    addressLine2?: string;
-    city: string;
-    stateCode: TUSStateCode;
-    postalCode: string;
-}
-export declare const formatAddress: (address: IAddress) => string;