@bearz/strings/types/split.d.ts

A collection of string utilities to avoid extra allocations and enable case insensitivity comparisons.

/**
 * Splits a string into an array of substrings based on a specified separator.
 *
 * @param str - The input string, Uint8Array, or Uint32Array.
 * @param separator - The separator string or regular expression.
 * @param trim - Optional. Specifies whether to trim the resulting substrings and
 * filter out empty strings. Defaults to `false`.
 * @param limit - Optional. The maximum number of substrings to return.
 * @returns An array of substrings.
 */
export declare function split(
    str: string | Uint8Array | Uint32Array,
    separator: string | RegExp,
    trim?: boolean,
    limit?: number,
): string[];