Skip to content

ComponentEx.getInFlightAncestryLoadPromise method

ComponentEx › getInFlightAncestryLoadPromise

Returns a Promise that settles once neither this component nor any ComponentEx ancestor has a load in flight, or null when none of them has one right now.

getInFlightLoadPromise covers this component's OWN load only. A sibling this component depends on — most often the owning plugin's settings component, which reads data.json asynchronously — is outside it, but it is inside the load of a shared ancestor. Waiting for every ancestor therefore waits for the whole tree the component was loaded as part of: under PluginBase the chain ends at the plugin's universal wrapper, whose load covers the dependency gate, the feature surface and onloadImpl.

The chain is followed through ComponentEx parents only. A plain Component anywhere between this component and an ancestor ends it, because a plain component records no parent and exposes no load promise.

Never await this from inside a load step of one of those ancestors: the ancestor's load would then be waiting for itself. It is meant for work scheduled OUTSIDE the load, such as a layout-ready handler.

Signature:

getInFlightAncestryLoadPromise(): null | Promise<void>

Returns: null | Promise<void> — The promise, or null if nothing in the ancestry is loading.