@modern-kit/utils/dist/string/trimStart/index.d.ts

modern-kit/utils

/**
 * @description 문자열에서 `선행 공백`을 제거합니다. `String.prototype.trimStart`와 동일하게 동작합니다.
 *
 * @param {string} str - 전체 문자열입니다.
 * @returns {string} - str에서 `선행 공백`을 제거한 문자열입니다.
 *
 * @example
 * trimStart('  abc'); // 'abc'
 */
declare function trimStart(str: string): string;
/**
 * @description 문자열에서 `지정된 문자들의 조합`을 문자열 시작 부분에서 찾아 제거합니다.
 *
 * chars가 문자열인 경우 해당 문자열을 각 문자로 나누고 문자열 시작 부분에서 이를 찾아 제거합니다.
 * - ex: `'+-*' -> ['+', '-', '*']`
 *
 * chars가 배열인 경우 배열 내 문자열을 각 문자로 나누고 문자열 시작 부분에서 이를 찾아 제거합니다.
 * - ex: `['+*', '-'] -> ['+', '*', '-']`
 *
 * @param {string} str - 전체 문자열입니다.
 * @param {string | string[]} chars - 문자열 앞부분에서 제거하고 싶은 문자열 혹은 문자열 배열입니다.
 * @returns {string} - str에서 앞에있는 공백 또는 지정된 chars를 제거한 문자열입니다.
 *
 * @example
 * trimStart('-_-abc', ['-', '_']); // 'abc-_-'
 * trimStart('+-*abc', ['+*', '-']); // 'abc'
 */
declare function trimStart(str: string, chars: string | string[]): string;

export { trimStart };