@turndown/library 0.1.64 → 0.1.66

package/dist/helpers/index.d.ts

@@ -0,0 +1,675 @@
+import { o as ISortCondition, e as IFilterCondition, D as TFilterConditionValue, X as TUSStateCode } from '../index-CzB45yLv.js';
+
+type TDateInput = Date | string | number | null | undefined;
+type TDateFormat = "MM/DD/YYYY" | "MM/DD/YY HH:mm A" | string;
+/**
+ * Format a date using a dayjs format string.
+ *
+ * @param {TDateInput} date - Date-like value to format.
+ * @param {TDateFormat} format - dayjs format string.
+ * @returns {string} Formatted date or `--` for missing/invalid input.
+ */
+declare const formatDate: (date?: TDateInput, format?: TDateFormat) => string;
+/**
+ * Return a human-readable relative time string.
+ *
+ * @param {TDateInput} date - Date-like value to compare against now.
+ * @returns {string} Relative time or `--` for missing/invalid input.
+ */
+declare const timeAgo: (date: TDateInput) => string;
+/**
+ * Add days to a date.
+ *
+ * @param {TDateInput} date - Source date.
+ * @param {number} days - Number of days to add.
+ * @returns {Date} Updated date.
+ */
+declare const addDays: (date: TDateInput, days: number) => Date;
+/**
+ * Subtract days from a date.
+ *
+ * @param {TDateInput} date - Source date.
+ * @param {number} days - Number of days to subtract.
+ * @returns {Date} Updated date.
+ */
+declare const subtractDays: (date: TDateInput, days: number) => Date;
+/**
+ * Return the absolute number of whole day boundaries between two dates.
+ *
+ * @param {TDateInput} dateA - First date.
+ * @param {TDateInput} dateB - Second date.
+ * @returns {number} Absolute difference in days, or 0 for invalid input.
+ */
+declare const daysBetween: (dateA: TDateInput, dateB: TDateInput) => number;
+/**
+ * Check whether a date is today.
+ *
+ * @param {TDateInput} date - Date-like value.
+ * @returns {boolean} True when the date is today.
+ */
+declare const isToday: (date: TDateInput) => boolean;
+/**
+ * Check whether a date is in the past.
+ *
+ * @param {TDateInput} date - Date-like value.
+ * @returns {boolean} True when the date is before now.
+ */
+declare const isPast: (date: TDateInput) => boolean;
+/**
+ * Check whether a date is in the future.
+ *
+ * @param {TDateInput} date - Date-like value.
+ * @returns {boolean} True when the date is after now.
+ */
+declare const isFuture: (date: TDateInput) => boolean;
+/**
+ * Return the start of the day for a date.
+ *
+ * @param {TDateInput} date - Source date.
+ * @returns {Date} Date set to 00:00:00.000.
+ */
+declare const startOfDay: (date: TDateInput) => Date;
+/**
+ * Return the end of the day for a date.
+ *
+ * @param {TDateInput} date - Source date.
+ * @returns {Date} Date set to 23:59:59.999.
+ */
+declare const endOfDay: (date: TDateInput) => Date;
+/**
+ * Return the ISO week start date, Monday at 00:00:00.000.
+ *
+ * @param {TDateInput} date - Source date.
+ * @returns {Date} Start of ISO week.
+ */
+declare const startOfWeek: (date: TDateInput) => Date;
+/**
+ * Return the ISO week end date, Sunday at 23:59:59.999.
+ *
+ * @param {TDateInput} date - Source date.
+ * @returns {Date} End of ISO week.
+ */
+declare const endOfWeek: (date: TDateInput) => Date;
+/**
+ * Return all seven dates in the ISO week containing the provided date.
+ *
+ * @param {TDateInput} date - Source date.
+ * @returns {Date[]} Monday-through-Sunday dates at the start of each day.
+ */
+declare const getWeekDays: (date: TDateInput) => Date[];
+/**
+ * Add weeks to a date.
+ *
+ * @param {TDateInput} date - Source date.
+ * @param {number} weeks - Number of weeks to add.
+ * @returns {Date} Updated date.
+ */
+declare const addWeeks: (date: TDateInput, weeks: number) => Date;
+/**
+ * Subtract weeks from a date.
+ *
+ * @param {TDateInput} date - Source date.
+ * @param {number} weeks - Number of weeks to subtract.
+ * @returns {Date} Updated date.
+ */
+declare const subtractWeeks: (date: TDateInput, weeks: number) => Date;
+
+type TRecord = Record<string, unknown>;
+type TSortableValue = string | number | bigint | boolean | Date | null | undefined;
+type TReplaceNulls<TValue> = TValue extends null ? "" : TValue extends (infer TItem)[] ? TReplaceNulls<TItem>[] : TValue extends Date ? TValue : TValue extends object ? {
+    [TKey in keyof TValue]: TReplaceNulls<TValue[TKey]>;
+} : TValue;
+/**
+ * Safely parse a JSON string into a typed value.
+ *
+ * When a fallback value is provided, the function always returns that generic
+ * type. Without a fallback value, parse failures return an empty object.
+ *
+ * @typeParam TParsed - Expected parsed value type.
+ * @param {string | null | undefined} jsonString - JSON string to parse.
+ * @param {TParsed} [fallbackValue] - Value returned when parsing fails.
+ * @returns {TParsed | Record<string, unknown>} Parsed value or fallback.
+ * @example
+ * parseJSON<{ a: number }>('{"a":1}', { a: 0 }) // => { a: 1 }
+ * parseJSON('not json') // => {}
+ */
+declare function parseJSON<TParsed>(jsonString: string | null | undefined, fallbackValue: TParsed): TParsed;
+declare function parseJSON(jsonString: string | null | undefined): Record<string, unknown>;
+/**
+ * Stringify a value to JSON while skipping circular references.
+ *
+ * Uses an internal cache to omit repeated object references that would
+ * normally cause `JSON.stringify` to throw.
+ *
+ * @param {unknown} value - Value to stringify.
+ * @returns {string | undefined} JSON string with circulars omitted.
+ * @example
+ * const value: Record<string, unknown> = {}; value.self = value;
+ * JSONStringify(value) // => "{}"
+ */
+declare const JSONStringify: (value: unknown) => string | undefined;
+/**
+ * Deep-remove `undefined` properties while preserving Dates and arrays.
+ *
+ * Object properties with `undefined` values are removed. Array items are
+ * preserved so array indexes do not shift.
+ *
+ * @typeParam TValue - Input value type.
+ * @param {TValue} value - Input value.
+ * @returns {TValue} Cleaned clone with `undefined` object properties removed.
+ */
+declare const removeUndefined: <TValue>(value: TValue) => TValue;
+/**
+ * Test whether a location object's `pathname` equals a key.
+ *
+ * @param {{ pathname?: string } | null | undefined} location - Object expected
+ * to have a `pathname`.
+ * @param {string} key - Path to compare.
+ * @returns {boolean}
+ * @example
+ * validPath({ pathname: "/home" }, "/home") // true
+ */
+declare const validPath: (location: {
+    pathname?: string;
+} | null | undefined, key: string) => boolean;
+/**
+ * Return the first element if the input is an array; otherwise return the value itself.
+ *
+ * @typeParam T - Element type.
+ * @param {T | T[]} input - A single value or an array.
+ * @returns {T} First element or the input value.
+ * @example
+ * returnObject([1,2,3]) // 1
+ * returnObject(5) // 5
+ */
+declare const returnObject: <T>(input: T | T[]) => T;
+/**
+ * Filter out items from `array1` whose `id` appears in `array2`.
+ *
+ * @typeParam T - Object type with an `id` field.
+ * @param {T[]} [array1] - Source array.
+ * @param {T[]} [array2] - Items whose `id`s should be excluded.
+ * @returns {T[]} Filtered array (or `[]` on invalid input).
+ */
+declare const filterArrayById: <T extends {
+    id: number | string;
+}>(array1?: T[], array2?: T[]) => T[];
+/**
+ * Sort an array of objects by a given property (ascending).
+ *
+ * Mutates the original array (uses `Array.prototype.sort`).
+ *
+ * @typeParam T - Object type.
+ * @typeParam TKey - Sortable property key.
+ * @param {T[]} array - Array to sort.
+ * @param {TKey} property - Property name to sort by.
+ * @returns {T[]} The same array instance, sorted (or empty array if input invalid).
+ */
+declare const sortArrayByProperty: <TKey extends PropertyKey, T extends Record<TKey, TSortableValue>>(array: T[], property: TKey) => T[];
+/**
+ * Recursively replace `null` values with empty strings.
+ *
+ * Works on primitives, arrays, Dates, and plain objects.
+ *
+ * @typeParam TValue - Input value type.
+ * @param {TValue} value - Input value.
+ * @returns {TReplaceNulls<TValue>} Value with all `null` replaced by `""`.
+ */
+declare const replaceNulls: <TValue>(value: TValue) => TReplaceNulls<TValue>;
+/**
+ * Recursively remove object keys that contain a dot (`.`).
+ *
+ * @typeParam TValue - Input value type.
+ * @param {TValue} value - Input object or array.
+ * @returns {TValue} New value with dotted keys removed at all levels.
+ */
+declare const removeFormProperties: <TValue>(value: TValue) => TValue;
+/**
+ * Recursively convert string booleans `"true"`/`"false"` to actual booleans.
+ *
+ * Leaves all other values unchanged.
+ *
+ * @typeParam TValue - Input value type.
+ * @param {TValue} value - Input object or array.
+ * @returns {TValue} New value with boolean-like strings converted.
+ */
+declare const convertStringBooleans: <TValue>(value: TValue) => TValue;
+/**
+ * Convenience helper to clean form-like data:
+ * - Removes `undefined` properties
+ * - Converts string booleans to booleans
+ * - Removes keys containing a dot (`.`)
+ *
+ * @typeParam TObject - Form data object type.
+ * @param {TObject} objectToClean - Input data.
+ * @returns {Partial<TObject>} Cleaned clone.
+ */
+declare const cleanFormData: <TObject extends TRecord>(objectToClean: TObject) => Partial<TObject>;
+/**
+ * Return a default pagination object, allowing optional sort and filters.
+ *
+ * @param {ISortCondition[]} [sort] - Optional sort conditions.
+ * @param {IFilterCondition[]} [filters] - Optional filter conditions.
+ * @returns {{ page: number; size: number; sort: ISortCondition[]; filters: IFilterCondition[] }}
+ * @example
+ * resetPagination() // => { page:1, size:25, sort:[], filters:[] }
+ */
+declare const resetPagination: (sort?: ISortCondition[], filters?: IFilterCondition[]) => {
+    page: number;
+    size: number;
+    sort: ISortCondition[];
+    filters: TFilterConditionValue[];
+};
+/**
+ * Format a string of digits into a U.S. phone number.
+ *
+ * Strips non-numeric characters and formats 10 digits as `(XXX) XXX-XXXX`.
+ * Strips a leading US country code when 11 digits are provided.
+ * If a value cannot be formatted, returns the original value as a string.
+ *
+ * @param {string | number} value - Phone number digits (string or number).
+ * @returns {string} Formatted phone number, or original input if invalid length.
+ * @example
+ * formatPhoneNumber("1234567890") // "(123) 456-7890"
+ * formatPhoneNumber(9876543210)   // "(987) 654-3210"
+ * formatPhoneNumber("555")        // "555"
+ */
+declare const formatPhoneNumber: (value: string | number) => string;
+/**
+ * Remove comma separators from a number-like value.
+ *
+ * @param {number | string} value - Number-like value.
+ * @returns {string} Value without comma separators.
+ */
+declare const parseNumber: (value: number | string) => string;
+/**
+ * Delete a property from an object if it exists (no-op if it doesn't).
+ *
+ * @typeParam TObject - Object type.
+ * @param {TObject} objectToUpdate - Target object (mutated).
+ * @param {keyof TObject | string} propertyName - Property to delete.
+ * @returns {void}
+ */
+declare const deletePropertyIfExists: <TObject extends TRecord>(objectToUpdate: TObject, propertyName: keyof TObject | string) => void;
+/**
+ * Split an array into chunks of a given size.
+ *
+ * @typeParam T - Element type.
+ * @param {T[]} array - Source array.
+ * @param {number} chunkSize - Size of each chunk.
+ * @returns {T[][]} Array of chunks (last one may be smaller).
+ * @example
+ * chunkArray([1,2,3,4,5], 2) // [[1,2],[3,4],[5]]
+ */
+declare const chunkArray: <T>(array: T[], chunkSize: number) => T[][];
+/**
+ * Return a shallow clone of `objectToOmitFrom` without the listed properties.
+ *
+ * @typeParam TObject - Source object type.
+ * @typeParam TKey - Keys to omit.
+ * @param {TObject} objectToOmitFrom - Source object.
+ * @param {readonly TKey[]} propsToOmit - Property names to omit.
+ * @returns {Omit<TObject, TKey>} New object without omitted props.
+ * @example
+ * omitProperties({a:1,b:2}, ["b"]) // { a:1 }
+ */
+declare const omitProperties: <TObject extends TRecord, TKey extends keyof TObject>(objectToOmitFrom: TObject, propsToOmit: readonly TKey[]) => Omit<TObject, TKey>;
+/**
+ * Safe `hasOwnProperty` check.
+ *
+ * @param {unknown} value - Value to test.
+ * @param {PropertyKey} key - Property name.
+ * @returns {boolean}
+ */
+declare const hasProperty: <TKey extends PropertyKey>(value: unknown, key: TKey) => value is Record<TKey, unknown>;
+/**
+ * Safe `hasOwnProperty` alias from the reference utilities.
+ *
+ * @param {unknown} value - Value to test.
+ * @param {PropertyKey} key - Property name.
+ * @returns {boolean}
+ */
+declare const hasOwnProp: <TKey extends PropertyKey>(value: unknown, key: TKey) => value is Record<TKey, unknown>;
+/**
+ * Determine if an object has at least one own enumerable property.
+ *
+ * @param {unknown} value - Object to test.
+ * @returns {boolean} `true` if there is at least one key.
+ */
+declare const hasProperties: (value: unknown) => boolean;
+/**
+ * Get the first own enumerable property value from an object.
+ *
+ * @typeParam TObject - Source object type.
+ * @param {TObject | null | undefined} value - Source object.
+ * @returns {TObject[keyof TObject] | null} First value, or null for empty/non-object input.
+ */
+declare const getFirstPropertyValue: <TObject extends TRecord>(value: TObject | null | undefined) => TObject[keyof TObject] | null;
+/**
+ * Get a nested value from an object using dot notation.
+ *
+ * @param {unknown} value - Source object.
+ * @param {string} path - Dot-delimited path.
+ * @returns {unknown} Nested value, or undefined when the path cannot be resolved.
+ * @example
+ * getNestedValue({ user: { name: "John" } }, "user.name") // "John"
+ */
+declare const getNestedValue: (value: unknown, path: string) => unknown;
+/**
+ * Set a nested value on an object using dot notation.
+ *
+ * Mutates and returns the provided object. Unsafe path segments are ignored to
+ * prevent prototype pollution.
+ *
+ * @typeParam TObject - Target object type.
+ * @param {TObject} objectToUpdate - Target object.
+ * @param {string} path - Dot-delimited path.
+ * @param {unknown} value - Value to set.
+ * @returns {TObject} The mutated target object.
+ * @example
+ * setNestedValue({}, "user.name", "John") // { user: { name: "John" } }
+ */
+declare const setNestedValue: <TObject extends TRecord>(objectToUpdate: TObject, path: string, value: unknown) => TObject;
+/**
+ * Deep clone a value while preserving Dates and circular references.
+ *
+ * @typeParam TValue - Input value type.
+ * @param {TValue} value - Value to clone.
+ * @returns {TValue} Deep clone of the input.
+ */
+declare const deepClone: <TValue>(value: TValue) => TValue;
+/**
+ * Flatten a nested object into dot notation.
+ *
+ * Arrays and Dates are treated as leaf values.
+ *
+ * @param {TRecord} value - Source object.
+ * @param {string} [prefix] - Internal prefix for recursion.
+ * @returns {TRecord} Flattened object.
+ * @example
+ * flatten({ user: { name: "John" } }) // { "user.name": "John" }
+ */
+declare const flatten: (value: TRecord, prefix?: string) => TRecord;
+/**
+ * Convert a dot-notation object into a nested object.
+ *
+ * Unsafe path segments are ignored to prevent prototype pollution.
+ *
+ * @param {TRecord} value - Dot-notation source object.
+ * @returns {TRecord} Nested object.
+ * @example
+ * unflatten({ "user.name": "John" }) // { user: { name: "John" } }
+ */
+declare const unflatten: (value: TRecord) => TRecord;
+
+/**
+ * String utilities for common text manipulation tasks.
+ */
+
+/**
+ * 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'
+ */
+declare const formatNumber: (value: string | number) => string;
+declare const normalCase: (str?: string) => string;
+declare const sentenceCase: (str?: string) => string;
+declare const upperCase: (str?: string) => string;
+declare const lowerCase: (str?: string) => string;
+/**
+ * Converts a string to camelCase.
+ *
+ * @example toCamelCase('hello-world') => 'helloWorld'
+ * @example toCamelCase('hello_world') => 'helloWorld'
+ */
+declare const toCamelCase: (str: string) => string;
+declare const camelCase: (str: string) => string;
+/**
+ * Converts a string to kebab-case.
+ *
+ * @example toKebabCase('helloWorld') => 'hello-world'
+ * @example toKebabCase('Hello_World') => 'hello-world'
+ */
+declare const toKebabCase: (str: string) => string;
+declare const kebabCase: (str: string) => string;
+/**
+ * Converts a string to snake_case.
+ *
+ * @example toSnakeCase('helloWorld') => 'hello_world'
+ * @example toSnakeCase('hello-world') => 'hello_world'
+ */
+declare const toSnakeCase: (str: string) => string;
+declare const snakeCase: (str: string) => string;
+/**
+ * Converts a string to PascalCase.
+ *
+ * @example toPascalCase('hello-world') => 'HelloWorld'
+ * @example toPascalCase('hello_world') => 'HelloWorld'
+ */
+declare const toPascalCase: (str: string) => string;
+declare const pascalCase: (str: string) => string;
+declare const snakeCaseToSpaces: (str: string) => string;
+declare const kebabToSpaces: (str: string) => string;
+/**
+ * Capitalizes the first character of a string.
+ *
+ * @example capitalize('hello world') => 'Hello world'
+ */
+declare const capitalize: (str: string) => string;
+/**
+ * Capitalizes the first letter of each word.
+ *
+ * @example titleCase('hello world') => 'Hello World'
+ */
+declare const titleCase: (str: string) => string;
+/**
+ * Truncates a string to a specified length and adds ellipsis.
+ *
+ * @example truncate('hello world', 5) => 'he...'
+ */
+declare const truncate: (str: string, length: number, suffix?: string) => string;
+/**
+ * Removes all whitespace from a string.
+ *
+ * @example removeWhitespace('hello world') => 'helloworld'
+ */
+declare const removeWhitespace: (str: string) => string;
+/**
+ * Removes all non-alphanumeric characters.
+ *
+ * @example removeSpecialChars('hello@world#123') => 'helloworld123'
+ */
+declare const removeSpecialChars: (str: string) => string;
+/**
+ * Generates a URL-friendly slug from a string.
+ *
+ * @example slug('Hello World 2024!') => 'hello-world-2024'
+ */
+declare const slug: (str: string) => string;
+/**
+ * Validates if a string is a valid email.
+ *
+ * @example isEmail('user@example.com') => true
+ */
+declare const isEmail: (str: string) => boolean;
+/**
+ * Validates if a string is a valid URL.
+ *
+ * @example isUrl('https://example.com') => true
+ */
+declare const isUrl: (str: string) => boolean;
+/**
+ * Validates if a string contains only numbers.
+ *
+ * @example isNumeric('12345') => true
+ * @example isNumeric('123abc') => false
+ */
+declare const isNumeric: (str: string) => boolean;
+/**
+ * Checks if a string is empty or contains only whitespace.
+ *
+ * @example isEmpty('  ') => true
+ * @example isEmpty('hello') => false
+ */
+declare const isEmpty: (str: string) => boolean;
+/**
+ * Reverses a string.
+ *
+ * @example reverse('hello') => 'olleh'
+ */
+declare const reverse: (str: string) => string;
+/**
+ * Repeats a string a specified number of times.
+ *
+ * @example repeat('ab', 3) => 'ababab'
+ */
+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'
+ */
+declare const padStart: (str: string, length: number, padChar?: string) => string;
+declare const padEnd: (str: string, length: number, padChar?: string) => string;
+/**
+ * Encodes a string to Base64.
+ *
+ * @example toBase64('hello') => 'aGVsbG8='
+ */
+declare const toBase64: (str: string) => string;
+/**
+ * Decodes a Base64 string.
+ *
+ * @example fromBase64('aGVsbG8=') => 'hello'
+ */
+declare const fromBase64: (str: string) => string;
+/**
+ * Counts the number of words in a string.
+ *
+ * @example wordCount('hello world test') => 3
+ */
+declare const wordCount: (str: string) => number;
+/**
+ * Counts the number of characters, excluding whitespace.
+ *
+ * @example charCount('hello world') => 10
+ */
+declare const charCount: (str: string) => number;
+/**
+ * Repeats a character a specified number of times.
+ *
+ * @example repeatChar('*', 5) => '*****'
+ */
+declare const repeatChar: (char: string, times: number) => string;
+/**
+ * Extracts numbers from a string.
+ *
+ * @example extractNumbers('abc123def456') => '123456'
+ */
+declare const extractNumbers: (str: string) => string;
+/**
+ * Removes duplicate consecutive characters.
+ *
+ * @example removeDuplicates('aabbccdd') => 'abcd'
+ */
+declare const removeDuplicates: (str: string) => string;
+/**
+ * Checks if a string is a palindrome.
+ *
+ * @example isPalindrome('racecar') => true
+ * @example isPalindrome('hello') => false
+ */
+declare const isPalindrome: (str: string) => boolean;
+/**
+ * Finds the longest word in a string.
+ *
+ * @example longestWord('the quick brown fox') => 'quick'
+ */
+declare const longestWord: (str: string) => string;
+/**
+ * Pluralizes common English words using a simple ruleset.
+ *
+ * @example pluralize('cat') => 'cats'
+ * @example pluralize('box') => 'boxes'
+ */
+declare const pluralize: (word: string) => string;
+/**
+ * Highlights a substring within a string by wrapping it with markers.
+ *
+ * @example highlight('hello world', 'world', '**') => 'hello **world**'
+ */
+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'
+ */
+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
+ */
+declare const stringSimilarity: (str1: string, str2: string) => number;
+/**
+ * Strips HTML tags from a string.
+ *
+ * @example stripHtml('<p>Hello <b>world</b></p>') => 'Hello world'
+ */
+declare const stripHtml: (str: string) => string;
+/**
+ * Replaces multiple spaces with a single space.
+ *
+ * @example normalizeSpaces('hello    world') => 'hello world'
+ */
+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
+ */
+declare const toNumber: (str: string) => number | null;
+/**
+ * Splits a string by multiple delimiters.
+ *
+ * @example splitMultiple('a,b;c:d', ',', ';', ':') => ['a', 'b', 'c', 'd']
+ */
+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
+ */
+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
+ */
+declare const containsAll: (str: string, ...substrings: string[]) => boolean;
+interface IAddress {
+    addressLine1: string;
+    addressLine2?: string;
+    city: string;
+    stateCode: TUSStateCode;
+    postalCode: string;
+}
+declare const formatAddress: (address: IAddress) => string;
+
+type Success<T> = {
+    data: T;
+    error: null;
+};
+type Failure<E> = {
+    data: null;
+    error: E;
+};
+type Result<T, E = unknown> = Success<T> | Failure<E>;
+declare const tryCatch: <T, E = unknown>(callback: () => T | Promise<T>) => Promise<Result<T, E>>;
+
+export { type IAddress, JSONStringify, type TDateFormat, type TDateInput, addDays, addWeeks, camelCase, capitalize, charCount, chunkArray, cleanFormData, containsAll, containsAny, convertStringBooleans, daysBetween, deepClone, deletePropertyIfExists, endOfDay, endOfWeek, escapeRegex, extractNumbers, filterArrayById, flatten, formatAddress, formatDate, formatNumber, formatPhoneNumber, fromBase64, getFirstPropertyValue, getNestedValue, getWeekDays, hasOwnProp, hasProperties, hasProperty, highlight, isEmail, isEmpty, isFuture, isNumeric, isPalindrome, isPast, isToday, isUrl, kebabCase, kebabToSpaces, longestWord, lowerCase, normalCase, normalizeSpaces, omitProperties, padEnd, padStart, parseJSON, parseNumber, pascalCase, pluralize, removeDuplicates, removeFormProperties, removeSpecialChars, removeUndefined, removeWhitespace, repeat, repeatChar, replaceNulls, resetPagination, returnObject, reverse, sentenceCase, setNestedValue, slug, snakeCase, snakeCaseToSpaces, sortArrayByProperty, splitMultiple, startOfDay, startOfWeek, stringSimilarity, stripHtml, subtractDays, subtractWeeks, timeAgo, titleCase, toBase64, toCamelCase, toKebabCase, toNumber, toPascalCase, toSnakeCase, truncate, tryCatch, unflatten, upperCase, validPath, wordCount };