Interface LoaderFunctionArgs<Context>

Arguments passed to loader functions

interface LoaderFunctionArgs<Context> {
    context: Context;
    params: Params<string>;
    request: Request;
}

Type Parameters

  • Context = DefaultContext

Hierarchy

  • DataFunctionArgs<Context>
    • LoaderFunctionArgs

Properties

context params request

Properties

context

context: Context

This is the context passed in to your server adapter's getLoadContext() function. It's a way to bridge the gap between the adapter's request/response API with your React Router app. It is only applicable if you are using a custom server adapter.

params

params: Params<string>

Dynamic route params for the current route.

Example

// app/routes.ts
route("teams/:teamId", "./team.tsx"),

// app/team.tsx
export function loader({
  params,
}: Route.LoaderArgs) {
  params.teamId;
  //        ^ string
}

request

request: Request

A Fetch Request instance which you can use to read headers (like cookies, and URLSearchParams from the request.

Settings

Member Visibility

On This Page

Properties