@witchcraft/layout
    Preparing search index...

    Class KnownError<T, TInfo>

    Creates a known error that extends the base Error with some extra information. All the variables used to create the error message are stored in it's info property so we can easily re-craft error messages for users.

    Type Parameters

    Hierarchy

    • Error
      • KnownError
    Index

    Constructors

    Properties

    Constructors

    • Type Parameters

      • T extends LayoutError = LayoutError
      • TInfo extends
            | { id: undefined
            | string }
            | { id: undefined | string }
            | { size: { height: number; width: number } }
            | Record<string, never>
            | { frame: LayoutFrame }
            | {
                frame: LayoutFrame;
                minSize: { height: number; width: number };
                nearbyFrames: LayoutFrame[];
            }
            | { frame: LayoutFrame }
            | { frame: LayoutFrame; minSize: number; newSize: number }
            | { frame: LayoutFrame; framesRequiredToBeDeleted: LayoutFrame[] } = ErrorInfo<T>

      Parameters

      Returns KnownError<T, TInfo>

    Properties

    code: T
    info: TInfo