@monstermann/fn/dist/string/split.d.ts

A utility library for TypeScript.

import { Split } from "string-ts";

//#region src/string/split.d.ts

/**
 * `split(target, source)`
 *
 * Splits `target` string into an array of substrings using `source` string or regular expression as the separator.
 *
 * ```ts
 * split("hello,world,test", ","); // ["hello", "world", "test"]
 * split("hello world", /\s+/); // ["hello", "world"]
 * ```
 *
 * ```ts
 * pipe("hello,world,test", split(",")); // ["hello", "world", "test"]
 * pipe("hello world", split(/\s+/)); // ["hello", "world"]
 * ```
 */
declare const split: {
  <U extends string>(delimiter: U): <T extends string>(target: T) => Split<T, U>;
  <U extends RegExp>(delimiter: U): <T extends string>(target: T) => string[];
  <T extends string, U extends string>(target: T, delimiter: U): Split<T, U>;
  <T extends string, U extends RegExp>(target: T, delimiter: U): string[];
};
//#endregion
export { split };