React Router API Reference
    Preparing search index...

    Type Alias GetLoadContextFunction

    GetLoadContextFunction: (
        event: APIGatewayProxyEventV2,
    ) => MiddlewareEnabled extends true
        ? MaybePromise<RouterContextProvider>
        : MaybePromise<AppLoadContext>

    A function that returns the value to use as context in route loader and action functions.

    You can think of this as an escape hatch that allows you to pass environment/platform-specific values through to your loader/action.

    Type declaration

      • (
            event: APIGatewayProxyEventV2,
        ): MiddlewareEnabled extends true
            ? MaybePromise<RouterContextProvider>
            : MaybePromise<AppLoadContext>

      • Parameters

        • event: APIGatewayProxyEventV2

        Returns MiddlewareEnabled extends true
            ? MaybePromise<RouterContextProvider>
            : MaybePromise<AppLoadContext>

    Settings

    Member Visibility