Function useErrorAlchemy

Returns {
    craftErrorLogger: ((props: CraftErrorLoggerProps) => ((err: unknown) => void));
    craftErrorResolver: ((props: CraftErrorResolverProps) => ((err: unknown) => void));
    craftErrorResolverMap: ((...mapping: ErrorMapEntry[]) => Map<typeof SynthesizedError, ((err: SynthesizedError) => void)>);
    craftErrorSynthesizer: ((middlewareChain: SynthesizerMiddlewareChain) => Synthesizer);
    craftErrorTransmuter: (<T>(detectorFunction: DetectorFunction, transmuterFunction: TransmuterFunction<T>) => Transmuter<T>);
    craftMysticError: ((props: {
        cause?: string;
        errorCode?: ErrorCode;
        name: string;
        severity?: Severity;
    }) => typeof CraftedMysticError);
    craftSynthesizedError: ((props: {
        cause?: string;
        errorCode?: ErrorCode;
        name: string;
        severity?: Severity;
    }) => typeof CraftedSynthesizedError);
}

An object containing functions for crafting errors and transmuters.

• craftErrorLogger: ((props: CraftErrorLoggerProps) => ((err: unknown) => void))

  Crafts a new error logger with the given properties.

  Param: props

  The properties of the error logger.

  Returns

  The crafted error logger function.

  • • (props): ((err: unknown) => void)

    • Crafts a new error logger with the given logger properties.

      Parameters

      • props: CraftErrorLoggerProps

        The logger properties.

      Returns ((err: unknown) => void)

      The crafted error logger function.

      • • (err): void

        • Parameters

          • err: unknown

          Returns void

• craftErrorResolver: ((props: CraftErrorResolverProps) => ((err: unknown) => void))

  Crafts a new error resolver with the given properties.

  Param: props

  The properties of the error resolver.

  Returns

  The crafted error resolver function.

  • • (props): ((err: unknown) => void)

    • Crafts a new error resolver with the given properties.

      Parameters

      • props: CraftErrorResolverProps

        The properties of the error resolver.

      Returns ((err: unknown) => void)

      The crafted error resolver function.

      • • (err): void

        • Parameters

          • err: unknown

          Returns void

• craftErrorResolverMap: ((...mapping: ErrorMapEntry[]) => Map<typeof SynthesizedError, ((err: SynthesizedError) => void)>)

  Crafts a new error resolver map with the given mappings.

  Param: mapping

  The error map entries.

  Returns

  The crafted error resolver map.

  • • (...mapping): Map<typeof SynthesizedError, ((err: SynthesizedError) => void)>

    • Crafts a new error resolver map with the given mappings.

      Parameters

      • Rest...mapping: ErrorMapEntry[]

        The error map entries.

      Returns Map<typeof SynthesizedError, ((err: SynthesizedError) => void)>

      The crafted error resolver map.

• craftErrorSynthesizer: ((middlewareChain: SynthesizerMiddlewareChain) => Synthesizer)

  Crafts a new error synthesizer with the given middleware chain.

  Param: middlewareChain

  The middleware chain of transmuters.

  Returns

  The crafted synthesizer.

  • • (middlewareChain): Synthesizer

    • Crafts a new error synthesizer with the given middleware chain, injecting module and context.

      Parameters

      • middlewareChain: SynthesizerMiddlewareChain

        The middleware chain of transmuters.

      Returns Synthesizer

      The crafted synthesizer.

• craftErrorTransmuter: (<T>(detectorFunction: DetectorFunction, transmuterFunction: TransmuterFunction<T>) => Transmuter<T>)

  Crafts a new transmuter with the given detector and transmuter functions.

  Template: T

  Param: detectorFunction

  The function to detect errors.

  Param: transmuterFunction

  The function to transmute errors.

  Returns

  The crafted transmuter.

  • • <T>(detectorFunction, transmuterFunction): Transmuter<T>

    • Crafts a new transmuter with the given detector and transmuter functions, injecting module and context.

      Type Parameters

      • T = any

      Parameters

      • detectorFunction: DetectorFunction

        The function to detect errors.
      • transmuterFunction: TransmuterFunction<T>

        The function to transmute errors.

      Returns Transmuter<T>

      The crafted transmuter.

• craftMysticError: ((props: {
      cause?: string;
      errorCode?: ErrorCode;
      name: string;
      severity?: Severity;
  }) => typeof CraftedMysticError)

  Crafts a new mystic error with the given properties.

  Param: props

  The properties of the mystic error.

  Returns

  The crafted mystic error.

  • • (props): typeof CraftedMysticError

    • Crafts a new mystic error with the given properties, injecting module and context.

      Parameters

      • props: {
            cause?: string;
            errorCode?: ErrorCode;
            name: string;
            severity?: Severity;
        }

        The properties of the mystic error.

        • Optionalcause?: string

        • OptionalerrorCode?: ErrorCode

        • name: string

        • Optionalseverity?: Severity

      Returns typeof CraftedMysticError

      The crafted mystic error.

• craftSynthesizedError: ((props: {
      cause?: string;
      errorCode?: ErrorCode;
      name: string;
      severity?: Severity;
  }) => typeof CraftedSynthesizedError)

  Crafts a new synthesized error with the given properties.

  Param: props

  The properties of the synthesized error.

  Returns

  The crafted synthesized error.

  • • (props): typeof CraftedSynthesizedError

    • Crafts a new synthesized error with the given properties, injecting module and context.

      Parameters

      • props: {
            cause?: string;
            errorCode?: ErrorCode;
            name: string;
            severity?: Severity;
        }

        The properties of the synthesized error.

        • Optionalcause?: string

        • OptionalerrorCode?: ErrorCode

        • name: string

        • Optionalseverity?: Severity

      Returns typeof CraftedSynthesizedError

      The crafted synthesized error.