remeda
Version:
A utility library for JavaScript and Typescript.
35 lines • 1.65 kB
text/typescript
//#region src/startsWith.d.ts
/**
* Determines whether the string begins with the provided prefix, and refines
* the output if possible. Uses the built-in [`String.prototype.startsWith`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith).
*
* @param data - The input string.
* @param prefix - The prefix to check for.
* @signature
* R.startsWith(data, prefix);
* @example
* R.startsWith("hello world", "hello"); // true
* R.startsWith("hello world", "world"); // false
* @dataFirst
* @category String
*/
declare function startsWith<T extends string, Prefix extends string>(data: T, prefix: string extends Prefix ? never : Prefix): data is T & `${Prefix}${string}`;
declare function startsWith(data: string, prefix: string): boolean;
/**
* Determines whether the string begins with the provided prefix, and refines
* the output if possible. Uses the built-in [`String.prototype.startsWith`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith).
*
* @param prefix - The prefix to check for.
* @signature
* R.startsWith(prefix)(data);
* @example
* R.pipe("hello world", R.startsWith("hello")); // true
* R.pipe("hello world", R.startsWith("world")); // false
* @dataLast
* @category String
*/
declare function startsWith<Prefix extends string>(prefix: string extends Prefix ? never : Prefix): <T extends string>(data: T) => data is T & `${Prefix}${string}`;
declare function startsWith(prefix: string): (data: string) => boolean;
//#endregion
export { startsWith };
//# sourceMappingURL=startsWith-CqsFnXpz.d.cts.map