remeda
Version:
A utility library for JavaScript and Typescript.
18 lines • 641 B
text/typescript
//#region src/isError.d.ts
type DefinitelyError<T> = Extract<T, Error> extends never ? Error : Extract<T, Error>;
/**
* A function that checks if the passed parameter is an Error and narrows its type accordingly.
*
* @param data - The variable to check.
* @returns True if the passed input is an Error, false otherwise.
* @signature
* R.isError(data)
* @example
* R.isError(new Error('message')) //=> true
* R.isError('somethingElse') //=> false
* @category Guard
*/
declare function isError<T>(data: Error | T): data is DefinitelyError<T>;
//#endregion
export { isError };
//# sourceMappingURL=isError-0vM0r3Kb.d.cts.map