React Router API Reference
    Preparing search index...

    Type Alias GetLoadContextFunction

    GetLoadContextFunction: (
        req: express.Request,
        res: express.Response,
    ) => 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, such as values that are generated by Express middleware like req.session.

    Type declaration

      • (
            req: express.Request,
            res: express.Response,
        ): MiddlewareEnabled extends true
            ? MaybePromise<RouterContextProvider>
            : MaybePromise<AppLoadContext>

      • Parameters

        • req: express.Request
        • res: express.Response

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

    Settings

    Member Visibility