@tempots/dom

@tempots/dom > ProvideGlobalProbe

ProvideGlobalProbe() function

Provides a global probe, which can be used to trigger a callback when all probes with the same identifier are resolved. To resolve a probe, call the done function passed using the UseProbe renderable.

Signature:

ProvideGlobalProbe: ({ callback, timeout, }: {
    callback?: (resolution: ProbeResolution) =&gt; void;
    timeout?: number;
}, child: TNode) =&gt; Renderable

Parameters

Parameter	Type	Description
{ callback, timeout, }	{ callback?: (resolution: ProbeResolution) => void; timeout?: number; }
child	TNode	The child component to be provided with the probe.

Returns: Renderable

The child component with the probe.