menu
menuAPI
Options to the resource function, for creating a resource.
interface BaseResourceOptions<T, R> { params?: ((ctx: ResourceParamsContext) => R) | undefined; defaultValue?: NoInfer<T> | undefined; equal?: ValueEqualityFn<T> | undefined; injector?: Injector | undefined; id?: string | undefined;}
((ctx: ResourceParamsContext) => R) | undefinedA reactive function which determines the request to be made. Whenever the request changes, the loader will be triggered to fetch a new value for the resource.
If a params function isn't provided, the loader won't rerun unless the resource is reloaded.
NoInfer<T> | undefinedThe value which will be returned from the resource when a server value is unavailable, such as when the resource is still loading.
ValueEqualityFn<T> | undefinedEquality function used to compare the return value of the loader.
string | undefinedIdentifier used to cache the resource data in the TransferState during server-side rendering and to retrieve it on the client side.
This value value needs to be identical for both the client and server.