es-toolkit/dist/compat/string/split.d.ts

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

/**
 * Splits the input string by the specified `separator`
 * and returns a new array containing the split segments.
 *
 * @param {string | null | undefined} [string=''] The string to split.
 * @param {RegExp|string} [separator] The separator pattern to split by.
 * @param {number} [limit] The length to truncate results to.
 * @returns {Array} Returns the string segments.
 *
 * @example
 * split('a-b-c', '-');
 * // => ['a', 'b', 'c']
 *
 * split('a-b-c', '-', 2);
 * // => ['a', 'b']
 */
declare function split(string: string | null | undefined, separator?: RegExp | string, limit?: number): string[];
/**
 * Splits the input string by the specified `separator`
 * and returns a new array containing the split segments.
 *
 * @param {string | null | undefined} [string=''] The string to split.
 * @param {RegExp|string} [separator] The separator pattern to split by.
 * @param {number} [limit] The length to truncate results to.
 * @returns {Array} Returns the string segments.
 *
 * @example
 * split('a-b-c', '-');
 * // => ['a', 'b', 'c']
 *
 * split('a-b-c', '-', 2);
 * // => ['a', 'b']
 */
declare function split(string: string | null | undefined, index: string | number, guard: object): string[];

export { split };