Class ResourcePage

A resource manager for lazy-loaded React components with Suspense integration. This class handles the loading state, caching, and Suspense integration for dynamically imported components.

Example

const resource = new ResourcePage(
  () => import('./MyComponent'),
  'MyComponent'
);

// In a React component with Suspense boundary:
const Component = resource.read();
return <Component />;

Index

Constructors

constructor

Methods

get getModuleId load read

Constructors

constructor

new ResourcePage(loader: ResourcePageLoader, moduleId: string): ResourcePage
Creates a new ResourcePage instance.
Parameters
- loader: ResourcePageLoader
  Function that returns a Promise resolving to the component
- moduleId: string
  Unique identifier for caching purposes
Returns ResourcePage
- Defined in packages/router/src/ResourcePage.tsx:41

Methods

get

get(): ResourcePageReturn | undefined
Returns the loaded component if available, undefined otherwise. This method can be used to check if the component is already loaded without triggering a load or throwing an error.

Returns ResourcePageReturn | undefined
The loaded component or undefined if not yet loaded
- Defined in packages/router/src/ResourcePage.tsx:72

getModuleId

getModuleId(): string
Returns the module identifier associated with this resource (debug helper).

Returns string
- Defined in packages/router/src/ResourcePage.tsx:79

load

load(): Promise<ResourcePageReturn>
Loads the resource if not already loaded or loading. This method can be called multiple times safely - it will return the same promise.

Returns Promise<ResourcePageReturn>
Promise that resolves to the loaded component
- Defined in packages/router/src/ResourcePage.tsx:61

read

read(): ResourcePageReturn | Promise<ResourcePageReturn> | Error
Reads the resource with React Suspense integration. This is the key method for integrating with React Suspense:
- Returns the component if loaded
- Throws an error if loading failed
- Throws a Promise if still loading (Suspense will catch this)
Returns ResourcePageReturn | Promise<ResourcePageReturn> | Error
The loaded component

Throws
Promise when loading (caught by Suspense)

Throws
Error when loading failed
- Defined in packages/router/src/ResourcePage.tsx:94

Class ResourcePage

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ResourcePage

Methods

get

Returns ResourcePageReturn | undefined

getModuleId

Returns string

load

Returns Promise<ResourcePageReturn>

read

Returns ResourcePageReturn | Promise<ResourcePageReturn> | Error

Throws

Throws

Settings

On This Page