Interface UseMountedSourceResult<T>`Experimental`

Result of useMountedSource.

interface UseMountedSourceResult<T = Record<string, unknown>> {
    diagnostics: MountedSourceDiagnostics | null;
    error: unknown;
    handle: MountedSource<T> | null;
    isMounting: boolean;
    refresh: () => void;
}

Type Parameters

T = Record<string, unknown>

Index

Properties

diagnostics error handle isMounting refresh

Properties

`Experimental`diagnostics

diagnostics: MountedSourceDiagnostics | null

Diagnostics snapshot from the mount and the latest applied update.

`Experimental`error

error: unknown

Mount or update failure, undefined while healthy.

`Experimental`handle

handle: MountedSource<T> | null

The live bridge handle, or null while unmounted / mounting / failed.

`Experimental`isMounting

isMounting: boolean

True while the initial mount (or a structural remount) is in flight.

`Experimental`refresh

refresh: () => void

Re-execute the current filter and diff-update the mounted data in place.