nhb-toolbox/dist/dts/string/basics.d.ts

A versatile collection of smart, efficient, and reusable utility functions, classes and types for everyday development needs.

import type { RandomIdOptions } from './types';
/**
 * * Utility to truncate a string to a specified length.
 *
 * @param str The string to truncate.
 * @param maxLength The maximum length of the truncated string.
 * @returns Truncated string with ellipsis (`...`) (only if it has more length than `maxLength`).
 */
export declare function truncateString(str: string, maxLength: number): string;
/**
 * * Generates a random alphanumeric (16 characters long, this length is customizable in the options) ID string composed of an optional `prefix`, `suffix`, a `timestamp`, `caseOption` and a customizable `separator`.
 *
 * @param options Configuration options for random ID generation.
 * @returns The generated ID string composed of the random alphanumeric string of specified length with optional `timeStamp`, `prefix`, and `suffix`, `caseOption` and `separator`.
 *
 * @see {@link https://toolbox.nazmul-nhb.dev/docs/utilities/hash/uuid uuid} for `uuid` generation
 * @see {@link https://toolbox.nazmul-nhb.dev/docs/utilities/hash/randomHex randomHex} for random hexadecimal string generation
 *
 * @example
 * // Generate an ID with all default options
 * const id = generateRandomID();
 * // Example output: "swo8ckxwsc13w7xw"
 *
 * @example
 * // Generate an ID with a custom prefix and separator
 * const id = generateRandomID({ prefix: 'ID', separator: '-' });
 * // Example output: "ID-eh1ymwfxzwas9jte"
 *
 * @example
 * // Generate an ID with a timestamp
 * const id = generateRandomID({ timeStamp: false });
 * // Example output: "1764610287501pd3r4w85qwkuulgf"
 *
 * @example
 * // Generate an ID with a custom length for the random string
 * const id = generateRandomID({ length: 8 });
 * // Example output: "i623uiev"
 *
 * @example
 * // Generate an ID with a custom suffix
 * const id = generateRandomID({ suffix: 'END' });
 * // Example output: "3csf27a4800rbli9END"
 *
 * @example
 * // Generate an ID with a uppercase random string
 * const id = generateRandomID({ caseOption: "upper" });
 * // Example output: "H0VNU6O8XV1Y30HG"
 *
 * @example
 * // Generate an ID with all options customized
 * const id = generateRandomID({
 *   prefix: 'ID',
 *   suffix: 'END',
 *   timeStamp: true,
 *   length: 10,
 *   separator: '-',
 *   caseOption: "upper"
 * });
 * // Example output: "ID-1764610471474-4KSL51IB91-END"
 */
export declare function generateRandomID(options?: RandomIdOptions): string;
/**
 * * Trims all the words in a string.
 *
 * @param input The string to trim.
 * @returns Trimmed string.
 */
export declare function trimString(input: string): string;
/**
 * * Trims all the words in an array of strings.
 *
 * @param input The array of strings to trim.
 * @returns Trimmed array of strings.
 */
export declare function trimString(input: string[]): string[];