stax-monorepo
    Preparing search index...

    Interface SuspenseOptions<N, E, R1, RF, RC>

    Options for the suspense boundary (DOM-specialized version).

    The N parameter is the element type all three branches share. Inferred from the callbacks, defaults to HTMLElement | SVGElement. When all three branches return the same concrete element type (say HTMLDivElement), the return type of suspense preserves it — no cast needed at mount(...) sites.

    interface SuspenseOptions<N extends DOMElement, E, R1, RF, RC> {
        catch?: (error: E) => Element<N, never, RC>;
        delay?: DurationInput;
        fallback: () => Element<N, never, RF>;
        render: () => Element<N, E, R1>;
    }

    Type Parameters

    • N extends DOMElement
    • E
    • R1
    • RF
    • RC
    Index
    catch? delay? fallback render
    catch?: (error: E) => Element<N, never, RC>

    Optional error handler. If provided, errors from render are caught and this function is called to render an error state. Must have no requirements.

    delay?: DurationInput

    Delay before showing the fallback. If the render completes before this duration, no fallback is shown. Accepts Effect Duration strings like "200 millis", "1 second", or a number (milliseconds). If not provided, fallback is shown immediately.

    fallback: () => Element<N, never, RF>

    Function to render the loading/fallback state. Must have no requirements (will be rendered in detached context if delay > 0).

    render: () => Element<N, E, R1>

    Async function that returns the final element. Can fail with error type E if catch is provided.

    Settings
    Member Visibility

    On This Page
    Properties