Interface DataLoaderOptions<Params, Context>

Options of a route data loader.

interface DataLoaderOptions<Params extends Dict, 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.

Index

Properties

isPrefetch params route router signal

Properties

isPrefetch

isPrefetch: boolean

true if a loader is called during prefetch.

params

params: Params

Route params extracted from a location.

route

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

A route for which data is loaded.

router

router: Router<Context>

A router that triggered data loading.

signal

signal: AbortSignal

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