Interface DataLoaderOptions<Params, Context>

Options of a route data loader.

interface DataLoaderOptions<Params, Context> {
    isPrefetch: boolean;
    params: Params;
    route: Route<any, Params, any, Context>;
    router: Router<Context>;
    signal: AbortSignal;
}

Type Parameters

  • Params extends Dict

    Route params.

  • Context

    A router context.

Properties

isPrefetch: boolean

true if a loader is called during prefetch.

params: Params

Route params extracted from a location.

route: Route<any, Params, any, Context>

A route for which data is loaded.

router: Router<Context>

A router that triggered data loading.

signal: AbortSignal

A signal that is aborted if a loader result isn't needed anymore.