freeCodeCamp/client/src/utils/handled-error.ts

import { has } from 'lodash-es';

interface ErrorData {
  type?: string;
  message?: string;
  redirectTo?: string | null;
}

export const handledErrorSymbol = Symbol('handledError');

export type HandledError = Error & {
  [handledErrorSymbol]: ErrorData;
};

export function isHandledError(err: unknown): err is HandledError {
  return has(err, handledErrorSymbol);
}

export function unwrapHandledError(
  err: HandledError
): ErrorData | Record<string, never> {
  return handledErrorSymbol in err ? err[handledErrorSymbol] : {};
}

export function wrapHandledError(
  err: Error,
  { type, message, redirectTo }: ErrorData
): HandledError {
  (err as HandledError)[handledErrorSymbol] = {
    type,
    message,
    redirectTo
  };
  return err as HandledError;
}