webchalk-animate - v0.31.0
    Preparing search index...

    Type Alias ClipErrorGenerator

    ClipErrorGenerator: {
        <TError extends Error>(error: TError): TError;
        <TError extends Error>(
            ErrorClass: new (message: string) => TError,
            msg: string,
            elementOverride?: DOMElement,
        ): TError;
    }

    A function that throws detailed error using additional location information based on AnimClip, its target DOM element, its parent AnimSequence, and its parent AnimTimeline.

    Type Declaration

      • <TError extends Error>(error: TError): TError

      • If an Error instance is passed, the location is appended to it.

        Type Parameters

        Parameters

        • error: TError

          The Error instance to attach the location information to

        Returns TError

      • <TError extends Error>(
            ErrorClass: new (message: string) => TError,
            msg: string,
            elementOverride?: DOMElement,
        ): TError

      • If an Error class function is passed, it is used to create an Error instance with the msg parameter as the error message.

        Type Parameters

        Parameters

        • ErrorClass: new (message: string) => TError

          The Error class that will be instantiated.

        • msg: string

          The error message that will appear before the location information.

        • OptionalelementOverride: DOMElement

          An element used to explicitly set the DOM element in the edge case where the error occurs in the clip's constructor (where the field containing the DOM element is not yet set).

        Returns TError

    Settings

    Member Visibility