@igleite/tsutils/dist/string/string-utils.d.ts

Uma coleção de utilitários em TypeScript para facilitar o desenvolvimento no dia a dia.

/**
 * Classe utilitária para manipulação de strings.
 */
export declare class StringUtils {
    /**
     * Propriedade estática que representa uma string vazia.
     * @type {string}
     */
    static readonly Empty: string;
    /**
     * Verifica se uma string é nula, indefinida ou vazia.
     * @param {string} value - A string a ser verificada.
     * @returns {boolean} Verdadeiro se a string for nula, indefinida ou vazia; caso contrário, falso.
     *
     * @example
     * const result1 = StringUtils.isNullOrEmpty(null); // true
     * const result2 = StringUtils.isNullOrEmpty(''); // true
     * const result3 = StringUtils.isNullOrEmpty('test'); // false
     * const result4 = StringUtils.isNullOrEmpty(undefined); // true
     */
    static isNullOrEmpty(value: string | undefined | null): boolean;
    /**
     * Remove todos os caracteres que não são números de uma string.
     * @param {string} value - A string a ser filtrada.
     * @returns {string} A string contendo apenas os caracteres numéricos.
     *
     * @example
     * const result1 = StringUtils.extractNumericCharacters('abc123def'); // '123'
     * const result2 = StringUtils.extractNumericCharacters('!@#456$%^'); // '456'
     * const result3 = StringUtils.extractNumericCharacters('7890'); // '7890'
     * const result4 = StringUtils.extractNumericCharacters(''); // ''
     */
    static extractNumericCharacters(value: string): string;
    /**
   * Converte a primeira letra de uma string para maiúscula.
   * @param {string} value - A string a ser capitalizada.
   * @returns {string} A string com a primeira letra em maiúscula.
   *
   * @example
   * const result1 = StringUtils.capitalize('hello'); // 'Hello'
   * const result2 = StringUtils.capitalize('world'); // 'World'
   * const result3 = StringUtils.capitalize('typescript'); // 'Typescript'
   * const result4 = StringUtils.capitalize('JAVASCRIPT'); // 'Javascript'
   * const result5 = StringUtils.capitalize(''); // ''
   */
    static capitalize(value: string): string;
}