@settlemint/sdk-utils/dist/string.d.cts

Shared utilities and helper functions for SettleMint SDK modules

//#region src/string.d.ts
/**
 * Capitalizes the first letter of a string.
 *
 * @param val - The string to capitalize
 * @returns The input string with its first letter capitalized
 *
 * @example
 * import { capitalizeFirstLetter } from "@settlemint/sdk-utils";
 *
 * const capitalized = capitalizeFirstLetter("hello");
 * // Returns: "Hello"
 */
declare function capitalizeFirstLetter(val: string): string;
/**
 * Converts a camelCase string to a human-readable string.
 *
 * @param s - The camelCase string to convert
 * @returns The human-readable string
 *
 * @example
 * import { camelCaseToWords } from "@settlemint/sdk-utils";
 *
 * const words = camelCaseToWords("camelCaseString");
 * // Returns: "Camel Case String"
 */
declare function camelCaseToWords(s: string): string;
/**
 * Replaces underscores and hyphens with spaces.
 *
 * @param s - The string to replace underscores and hyphens with spaces
 * @returns The input string with underscores and hyphens replaced with spaces
 *
 * @example
 * import { replaceUnderscoresAndHyphensWithSpaces } from "@settlemint/sdk-utils";
 *
 * const result = replaceUnderscoresAndHyphensWithSpaces("Already_Spaced-Second");
 * // Returns: "Already Spaced Second"
 */
declare function replaceUnderscoresAndHyphensWithSpaces(s: string): string;
/**
 * Truncates a string to a maximum length and appends "..." if it is longer.
 *
 * @param value - The string to truncate
 * @param maxLength - The maximum length of the string
 * @returns The truncated string or the original string if it is shorter than the maximum length
 *
 * @example
 * import { truncate } from "@settlemint/sdk-utils";
 *
 * const truncated = truncate("Hello, world!", 10);
 * // Returns: "Hello, wor..."
 */
declare function truncate(value: string, maxLength: number): string;
//#endregion
export { camelCaseToWords, capitalizeFirstLetter, replaceUnderscoresAndHyphensWithSpaces, truncate };
//# sourceMappingURL=string.d.cts.map