@technobuddha/library/src/to-error.ts

A large library of useful functions

import { toString } from './to-string.ts';

/**
 * Convert the entity to an Error object.
 * @param entity - The entity to convert, if it is already an error ir will be returned
 * otherwise a new Error object will be created.
 * @returns The entity as an Error object.
 * @group Object
 * @category Conversion
 * @example
 * ```typescript
 * toError(new Error('fail')); // returns the same Error object
 * toError('fail'); // returns Error: fail
 * toError(404); // returns Error: 404
 * ```
 */
export function toError(entity: unknown): Error {
  return Error.isError(entity) ? entity : new Error(toString(entity));
}