sveltekit-enhance
    Preparing search index...

    Type Alias EnhanceInput<CallType, Params, RouteId, ParentData>

    EnhanceInput: {
        callType: CallType;
        cookies: Cookies;
        fetch: typeof fetch;
        getClientAddress?: () => string;
        isDataRequest: boolean;
        isRemoteRequest: boolean;
        isSubRequest: boolean;
        locals: App.Locals;
        params: Params;
        request: Request;
        route: { id: RouteId };
        setHeaders: (headers: Record<string, string>) => void;
        tracing: RequestEvent["tracing"];
        url: URL;
        get errorHandlers(): EnhanceErrorHandler[];
    } & (
        CallType extends "handle"
            ? {
                event: RequestEvent;
                resolve: (
                    event?: RequestEvent,
                    opts?: ResolveOptions,
                ) => MaybePromise<Response>;
                get responseHandlers(): EnhanceResponseHandler[];
            }
            : CallType extends "load"
                ? {
                    depends: ServerLoadEvent<Params, ParentData, RouteId>["depends"];
                    parent: ServerLoadEvent<Params, ParentData, RouteId>["parent"];
                    untrack: ServerLoadEvent<Params, ParentData, RouteId>["untrack"];
                }
                : object
    )

    Type Parameters

    • CallType extends EnhanceCallType = EnhanceCallType
    • Params extends AppLayoutParams<"/"> = AppLayoutParams<"/">
    • RouteId extends AppRouteId | string | null = AppRouteId | string | null
    • ParentData extends Record<string, any> = Record<string, any>

    Type Declaration

    • callType: CallType
    • cookies: Cookies
    • fetch: typeof fetch
    • OptionalgetClientAddress?: () => string
    • isDataRequest: boolean

      true if the request comes from the client asking for +page/layout.server.js data. Available in all contexts (handle, load, action, method).

    • isRemoteRequest: boolean

      true if the request comes from the client via a remote function. Available in all contexts (handle, load, action, method).

    • isSubRequest: boolean

      true for +server.js calls made via same-origin fetch on the server (no HTTP overhead). Available in all contexts (handle, load, action, method).

    • locals: App.Locals
    • params: Params
    • request: Request
    • route: { id: RouteId }
    • setHeaders: (headers: Record<string, string>) => void

      Set response headers. Available in all contexts (handle, load, action, method). Cannot set set-cookie — use the cookies API instead.

    • tracing: RequestEvent["tracing"]

      Access to OpenTelemetry spans. Spans are no-ops when tracing is disabled. Available in all contexts (handle, load, action, method).

      SvelteKit 2.31.0

    • url: URL
    • get errorHandlers(): EnhanceErrorHandler[]

    Settings

    Member Visibility